Common (org.gonn:gava 0.0.1 API)

java.lang.Object
- org.gonn.gava.Common

```
public class Common
extends Object
```
Basic static functions

Version:

1.3.3

Author:

Gon Yi

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DAY`
`static String`	`ENV_VAR_VERBOSE` Default params set when any of the method was first used.
`static long`	`EPOCH_STARTED`
`static int`	`HOUR`
`static int`	`MINUTE`
`static int`	`SECOND`
`static boolean`	`VERBOSE_MODE`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static int`	`count(String[] s, String key)` How many times String key was in the String array s.
`static int`	`count(String s, char c)` Count char c from String s, returns int of how many times char c was used.
`static int`	`count(String s, String search)`
`static void`	`debug(java.util.function.Supplier<String> s)`
`static String`	`epochToString()` Time since EPOCH_STARTED in string format
`static String`	`epochToString(long epochMillis)` Returns UTC time from epochMillis.
`static String`	`epochToString(long epoch, int offsetHr)` Return epoch time with offset.
`static String`	`epochToString(long epoch, int offsetHr, boolean signed)` Converts epoch milliseconds to human-readable time format.
`static void`	`error(java.util.function.Supplier<String> s)`
`static char`	`first(String s)`
`static <T> T`	`first(T[] t)`
`static <T> T`	`get(java.util.function.Supplier<T> f)` Evaluates the given function and return the result.
`static String`	`getByteSizeString(long numOfBytes)` Get bytes in long, and returns human-readable format with 2 digit decimal.
`static String`	`getCaller()` Returns caller information in "filename:lineNumber" format.
`static StackTraceElement`	`getCaller(int skip)` Get a StackTraceElement of the caller to find out who called this function.
`static String`	`getConfig(String key)`
`static boolean`	`getConfig(String key, boolean fallback)` Check (1) system properties, and then (2) environmental variables.
`static String`	`getConfig(String key, String fallback)`
`static int`	`getDigits(long n)` Get an integer and calculate number of digits.
`static long`	`getEpoch()` Returns current epoch milliseconds.
`static int`	`getHash(String s)` Get hash from string
`static String`	`getNth(String s, char delim, int index)` Returns index element from the String s when separated by char delim.
`static String`	`getStringBetween(String s, String prefix, String suffix)` Get a String between String prefix and String suffix from String s.
`static long`	`getTimed(Runnable r, int count)` Run lambda function Runnable r for count times.
`static void`	`info(java.util.function.Supplier<String> s)`
`static String`	`join(String delimiter, Object... objs)`
`static char`	`last(String s)`
`static <T> T`	`last(T[] t)`
`static void`	`log(String prefix, String msg)` Whenever static method log() is called, it will print to System.out.
`static String`	`ltrim(String s)`
`static void`	`main(String[] args)`
`static void`	`parseArgs(String[] args, java.util.function.BiConsumer<String,String> f)` Handles args such as `--name="Gon"`
`static void`	`println(Object... any)`
`static void`	`prints(String name, Object... objs)` Prints any objects in a line per item.
`static String`	`removePrefix(String s, char prefix)`
`static String`	`removePrefix(String s, String prefix)`
`static String`	`removeSuffix(String s, char suffix)`
`static String`	`removeSuffix(String s, String suffix)`
`static String`	`repeat(char c, int n)` Take a char c and repeat it n times, store it as a String.
`static String`	`repeat(String s, int n)`
`static String`	`rtrim(String s)`
`static boolean`	`sleep(long ms)` Shortcut function that calls Thread.sleep() but does not require try/catch.
`static String`	`substring(String s, int to)`
`static String`	`substring(String s, int idxFrom, int idxTo)` A static alternative substring method.
`static void`	`warn(java.util.function.Supplier<String> s)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ENV_VAR_VERBOSE
```
public static final String ENV_VAR_VERBOSE
```
    Default params set when any of the method was first used. EPOCH_STARTED -- record the time first library was used VERBOSE_MODE -- whether to log
    
    See Also:
    
    Constant Field Values
  - EPOCH_STARTED
```
public static final long EPOCH_STARTED
```
  - VERBOSE_MODE
```
public static final boolean VERBOSE_MODE
```
  - SECOND
```
public static final int SECOND
```
    See Also:
    
    Constant Field Values
  - MINUTE
```
public static final int MINUTE
```
    See Also:
    
    Constant Field Values
  - HOUR
```
public static final int HOUR
```
    See Also:
    
    Constant Field Values
  - DAY
```
public static final int DAY
```
    See Also:
    
    Constant Field Values
- Method Detail
  - repeat
```
public static String repeat(char c,
                            int n)
```
    Take a char c and repeat it n times, store it as a String.
    
    Parameters:
    
    c - char to repeat
    
    n - number of repeats
    
    Returns:
    
    String of the result
  - repeat
```
public static String repeat(String s,
                            int n)
```
  - count
```
public static int count(String s,
                        char c)
```
    Count char c from String s, returns int of how many times char c was used.
    
    Parameters:
    
    s - String s to be checked for char c
    
    c - char c to lookup
    
    Returns:
    
    number of char c found in String s
  - count
```
public static int count(String s,
                        String search)
```
  - count
```
public static int count(String[] s,
                        String key)
```
    How many times String key was in the String array s.
    
    Parameters:
    
    s - String array
    
    key - String to search from the array
    
    Returns:
    
    number of key in s.
  - rtrim
```
public static String rtrim(String s)
```
  - ltrim
```
public static String ltrim(String s)
```
  - substring
```
public static String substring(String s,
                               int idxFrom,
                               int idxTo)
```
    A static alternative substring method. This method supports negative index. String s = "hello Gon"; substring(s, -3, 0); // returns Gon substring(s, -3, -1); // returns Go
    
    Parameters:
    
    s -
    
    idxFrom - index of substring from
    
    idxTo - index of substring to; when its value is 0, it means until end of the string.
  - substring
```
public static String substring(String s,
                               int to)
```
  - getStringBetween
```
public static String getStringBetween(String s,
                                      String prefix,
                                      String suffix)
```
    Get a String between String prefix and String suffix from String s. String s = "https://gonn.org/test"; getStringBetween(s, "https://", "/test"); // returns gonn.org
    
    Parameters:
    
    s - String from
    
    prefix - prefix to search
    
    suffix - suffix to search
  - getNth
```
public static String getNth(String s,
                            char delim,
                            int index)
```
    Returns index element from the String s when separated by char delim. String s = "Gon|Yi|41|Conway|AR|72034"; getNth(s, '|', 3) // returns Conway
    
    Parameters:
    
    s - input String s
    
    delim - delimiter char to separate
    
    index - an index to search from the separated String s.
  - first
```
public static <T> T first(T[] t)
```
  - first
```
public static char first(String s)
```
  - last
```
public static <T> T last(T[] t)
```
  - last
```
public static char last(String s)
```
  - removePrefix
```
public static String removePrefix(String s,
                                  String prefix)
```
  - removePrefix
```
public static String removePrefix(String s,
                                  char prefix)
```
  - removeSuffix
```
public static String removeSuffix(String s,
                                  String suffix)
```
  - removeSuffix
```
public static String removeSuffix(String s,
                                  char suffix)
```
  - getEpoch
```
public static long getEpoch()
```
    Returns current epoch milliseconds.
    
    Returns:
    
    epochMillis
  - epochToString
```
public static String epochToString(long epoch,
                                   int offsetHr,
                                   boolean signed)
```
    Converts epoch milliseconds to human-readable time format. Note: Date is not considered here, and returns only time part (hour, minute, second, and millisecond)
    
    Parameters:
    
    epoch - Epoch milliseconds
    
    offsetHr - Any offset in hour. (i.g. -6 for CST) If 0 is given, this will return UTC.
    
    signed - Whether to show +/- sign.
    
    Returns:
    
    Human-readable epoch time. i.g. "15:04:05.000"
  - epochToString
```
public static String epochToString(long epoch,
                                   int offsetHr)
```
    Return epoch time with offset.
  - epochToString
```
public static String epochToString(long epochMillis)
```
    Returns UTC time from epochMillis.
    
    Parameters:
    
    epochMillis - epoch millisecond
    
    Returns:
    
    String format such as 15:04:05.000
  - epochToString
```
public static String epochToString()
```
    Time since EPOCH_STARTED in string format
    
    Returns:
    
    formatted epoch since
  - prints
```
public static void prints(String name,
                          Object... objs)
```
    Prints any objects in a line per item. This can be used during quick debugging.
    
    Parameters:
    
    name - Name of the group
    
    objs - Any object(s)
  - println
```
public static void println(Object... any)
```
  - join
```
public static String join(String delimiter,
                          Object... objs)
```
  - getDigits
```
public static int getDigits(long n)
```
    Get an integer and calculate number of digits. Note that this uses long type even when int or short type is given.
    
    Parameters:
    
    n - number to evaluate
    
    Returns:
    
    number of digits in int
  - getByteSizeString
```
public static String getByteSizeString(long numOfBytes)
```
    Get bytes in long, and returns human-readable format with 2 digit decimal. If the size is negative, it will have "-" (minus sign). This is the simplest and only handles from B to GB. (e.g. 1TB will be 1024GB)
    
    Parameters:
    
    numOfBytes - of a file or memory in byte (B).
    
    Returns:
    
    size with the unit such as "12.00KB" with two decimals.
  - getConfig
```
public static boolean getConfig(String key,
                                boolean fallback)
```
    Check (1) system properties, and then (2) environmental variables. IF "false" is to be noticed, set fallback as "true." IF "true" is to be noticed, set fallback as "false."
    
    Parameters:
    
    key - property/variable name
    
    fallback - default fallback value
    
    Returns:
  - getConfig
```
public static String getConfig(String key,
                               String fallback)
```
  - getConfig
```
public static String getConfig(String key)
```
  - parseArgs
```
public static void parseArgs(String[] args,
                             java.util.function.BiConsumer<String,String> f)
```
    Handles args such as `--name="Gon"`
    
    Parameters:
    
    args - String[] as main args
    
    f - BiConsumer function, when single param such as `--disable` is given, 2nd argument for the BiConsumer will be null.
  - getCaller
```
public static StackTraceElement getCaller(int skip)
```
    Get a StackTraceElement of the caller to find out who called this function.
    
    Parameters:
    
    skip - how many skips required
    
    Returns:
    
    Caller's StackTraceElement.
  - getCaller
```
public static String getCaller()
```
    Returns caller information in "filename:lineNumber" format. (e.g. "Gava.java:123")
  - getTimed
```
public static long getTimed(Runnable r,
                            int count)
```
    Run lambda function Runnable r for count times.
    
    Parameters:
    
    r - lambda to run
    
    count - how many times to run
    
    Returns:
    
    duration of the run in milliseconds.
  - sleep
```
public static boolean sleep(long ms)
```
    Shortcut function that calls Thread.sleep() but does not require try/catch. This returns true, when sleep ended normally, otherwise false. Note that this method does not throw any exception, but will log if verbose mode.
    
    Parameters:
    
    ms - milliseconds
  - log
```
public static void log(String prefix,
                       String msg)
```
    Whenever static method log() is called, it will print to System.out. To control, one can use a static method isVerbose() to check if the mode is verbose if(isVerbose()) log(" [DEBUG] ", "debug!"); // Usage 1 -- completely manually, not recommended. if(isVerbose()) info("some info here"); // Usage 2 -- recommended when the message isn't static.
    
    Parameters:
    
    prefix - to be added right after the timestamp.
    
    msg - message to print.
  - debug
```
public static void debug(java.util.function.Supplier<String> s)
```
  - info
```
public static void info(java.util.function.Supplier<String> s)
```
  - warn
```
public static void warn(java.util.function.Supplier<String> s)
```
  - error
```
public static void error(java.util.function.Supplier<String> s)
```
  - get
```
public static <T> T get(java.util.function.Supplier<T> f)
```
    Evaluates the given function and return the result. This is to reduce code. boolean xb = Gava.get(()->true); String xs = Gava.get(()->"blah"); int xi = Gava.get(()->123);
    
    Type Parameters:
    
    T - any
    
    Parameters:
    
    f - supplier function that takes type T.
    
    Returns:
    
    result of function f.
  - getHash
```
public static int getHash(String s)
```
    Get hash from string
  - main
```
public static void main(String[] args)
```

Class Common

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ENV_VAR_VERBOSE

EPOCH_STARTED

VERBOSE_MODE

SECOND

MINUTE

HOUR

DAY

Method Detail

repeat

repeat

count

count

count

rtrim

ltrim

substring

substring

getStringBetween

getNth

first

first

last

last

removePrefix

removePrefix

removeSuffix

removeSuffix

getEpoch

epochToString

epochToString

epochToString

epochToString

prints

println

join

getDigits

getByteSizeString

getConfig

getConfig

getConfig

parseArgs

getCaller

getCaller

getTimed

sleep

log

debug

info

warn

error

get

getHash

main