CommonUtils (eu.ralph-schuster.baselib 1.2.5 API)

java.lang.Object
- rs.baselib.util.CommonUtils

```
public class CommonUtils
extends Object
```
Common Utils.

Author:

ralph

Constructor Summary

Constructors
Constructor and Description

CommonUtils()

Constructors
Constructor and Description
`CommonUtils()`

Method Summary

Methods
Modifier and Type	Method and Description
`static int`	`compareVersion(String[] v1, String[] v2)` Compares versions.
`static int`	`compareVersion(String v1, String v2)` Compares software versions.
`static DateFormat`	`DATE_FORMATTER()` The formatter for dates (see `DateFormat.SHORT`).
`static DateFormat`	`DATE_TIME_FORMATTER()` The formatter for dates incl. times (see `DateFormat.SHORT`).
`static String`	`debugObject(Object o)` Recursively debugs objects.
`static void`	`debugObject(StringBuffer s, Object o)` Recursively debugs objects and adds this in the string buffer.
`static void`	`debugObject(StringBuilder s, Object o)` Recursively debugs objects and adds this in the string builder.
`static void`	`debugStackTrace(Logger log)` Dumps the stacktrace in DEBUG mode.
`static boolean`	`equals(Object o1, Object o2)` Checks for equality null-safe
`static void`	`errorStackTrace(Logger log)` Dumps the stacktrace in ERROR mode.
`static String`	`getDisplay(Enum<?> e)` Returns the display string for the default locale.
`static String`	`getDisplay(Enum<?> e, Locale locale)` Returns the display string for the given locale.
`static String`	`getDisplay(Object o)`
`static String`	`getDisplay(Object o, Locale locale)` Returns the display string of an object.
`static Enum<?>`	`getEnum(Class<? extends Enum<?>> clazz, String display)` Returns the enum constant for given display in default locale.
`static Enum<?>`	`getEnum(Class<? extends Enum<?>> clazz, String display, Locale locale)` Returns the enum constant for given display in given locale.
`static List<Enum<?>>`	`getOptionList(Class<? extends Enum<?>> clazz)` Returns a list of options from an enumeration class.
`static String[]`	`getOptions(Class<? extends Enum<?>> clazz)` Returns a list of options for display in default locale.
`static String[]`	`getOptions(Class<? extends Enum<?>> clazz, Locale locale)` Returns a list of options for display in given locale.
`static String`	`getOS()` Returns the OS name.
`static List<String>`	`getStackTrace(int ignoreLines)` Returns the current stacktrace.
`static long`	`getUnixTimestamp()` Returns the current time as UNIX timestamp.
`static long`	`getUnixTimestamp(Date date)` Returns the given date as UNIX timestamp.
`static long`	`getUnixTimestamp(long time)` Returns the given Java time as UNIX timestamp.
`static long`	`getUnixTimestamp(RsDate date)` Returns the given date as UNIX timestamp.
`static void`	`infoStackTrace(Logger log)` Dumps the stacktrace in INFO mode.
`static boolean`	`isCompatibleVersion(String minVersion, String maxVersion, String version)` Returns true if version is in range of minVersion and maxVersion.
`static boolean`	`isEmpty(String s)` Returns true when the given string is null or - when trimmed - empty.
`static boolean`	`isEmpty(String s, boolean trim)` Returns true when the given string is null empty.
`static boolean`	`isMac()` Tells whether runtime is a Mac system.
`static boolean`	`isSolaris()` Tells whether runtime is a Windows system.
`static boolean`	`isUnix()` Tells whether runtime is a Unix system.
`static boolean`	`isWindows()` Tells whether runtime is a Windows system.
`static <T> Iterable<T>`	`iterable(Iterator<T> iterator)` Returns an iterable for the given iterator.
`static String`	`join(String separator, String[] parts)` Makes a join of a string array.
`static String`	`join(String separator, String[] parts, int startIndex)` Makes a join of a string array.
`static String`	`join(String separator, String[] parts, int startIndex, int endIndex)` Makes a join of a string array.
`static String`	`loadContent(File f)` Loads the content of a file as a string.
`static String`	`loadContent(File f, Charset charset)` Loads the content of a file as a string.
`static String`	`loadContent(InputStream in)` Loads the content of a stream as a string.
`static String`	`loadContent(InputStream in, Charset charset)` Loads the content of a stream as a string.
`static String`	`loadContent(Reader reader)` Loads the content of a reader as a string.
`static String`	`loadContent(String name)` Loads the content of a file as a string.
`static String`	`loadContent(String name, Charset charset)` Loads the content of a file as a string.
`static String`	`loadContent(URL url)` Loads the content of the URL as a string.
`static String`	`loadContent(URL url, Charset charset)` Loads the content of the URL as a string.
`static Properties`	`loadProperties(File file)` Loads a property file.
`static void`	`loadProperties(Properties props, File file)` Loads a property file.
`static void`	`loadProperties(Properties props, String file)` Loads a property file.
`static Properties`	`loadProperties(String file)` Loads a property file.
`static void`	`printStackTrace(PrintStream out, int ignoreLines)` Dumps the stacktrace into the print stream.
`static URL`	`setAnchor(URL url, String anchor)` Set the anchor id for at the given URL.
`static NumberFormat`	`SIMPLE_INT_FORMATTER()` Formatter for integers.
`static NumberFormat`	`SIMPLE_NUMBER_FORMATTER()` Formatter for real numbers.
`static void`	`stderrStackTrace()` Dumps the stacktrace so stderr.
`static void`	`stdoutStackTrace()` Dumps the stacktrace so stdout.
`static void`	`storeProperties(Properties props, File file)` Stores a property file.
`static void`	`storeProperties(Properties props, String file)` Stores a property file.
`static String`	`toString(byte[] b)` Generates a string presentation of the given bytes.
`static String`	`toString(float amount)` Formats the money value.
`static String`	`toString(Object[] o)` Generates a string presentation of the given objects.
`static String`	`toString(RsDate date)` Formats the given date.
`static String`	`toString(RsDay day)` Formats the given day.
`static String`	`toString(RsMonth month)` Formats the given month (1st day of month).
`static String`	`toString(RsYear year)` Formats the given year.
`static String`	`toString(String o)` Formats the string for display.
`static void`	`traceStackTrace(Logger log)` Dumps the stacktrace in TRACE mode.
`static void`	`writeContent(File f, String content)` Writes the string to a file.
`static void`	`writeContent(File f, String content, Charset charset)` Writes the string to a file.
`static void`	`writeContent(OutputStream out, String content)` Writes the string to a stream.
`static void`	`writeContent(OutputStream out, String content, Charset charset)` Writes the string to a stream.
`static void`	`writeContent(String name, String content)` Writes the string to a file.
`static void`	`writeContent(String name, String content, Charset charset)` Writes the string to a file.
`static void`	`writeContent(Writer writer, String content)` Writes the string to a writer.

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

- Constructor Detail
  - CommonUtils
```
public CommonUtils()
```
- Method Detail
  - DATE_FORMATTER
```
public static DateFormat DATE_FORMATTER()
```
    The formatter for dates (see DateFormat.SHORT).
  - DATE_TIME_FORMATTER
```
public static DateFormat DATE_TIME_FORMATTER()
```
    The formatter for dates incl. times (see DateFormat.SHORT).
  - SIMPLE_NUMBER_FORMATTER
```
public static NumberFormat SIMPLE_NUMBER_FORMATTER()
```
    Formatter for real numbers.
  - SIMPLE_INT_FORMATTER
```
public static NumberFormat SIMPLE_INT_FORMATTER()
```
    Formatter for integers.
  - toString
```
public static String toString(String o)
```
    Formats the string for display.
    
    Parameters:
    o - the category
    
    Returns:
    string display
  - toString
```
public static String toString(float amount)
```
    Formats the money value.
    
    Parameters:
    amount - amount to be formatted
    
    Returns:
    formatted string
  - toString
```
public static String toString(RsDate date)
```
    Formats the given date.
    
    Parameters:
    date - date to format
    
    Returns:
    the formatted string (see DATE_TIME_FORMATTER())
  - toString
```
public static String toString(RsDay day)
```
    Formats the given day.
    
    Parameters:
    day - day to format
    
    Returns:
    the formatted string (see DATE_FORMATTER())
  - toString
```
public static String toString(RsYear year)
```
    Formats the given year.
    
    Parameters:
    year - year to format
    
    Returns:
    the formatted string
  - toString
```
public static String toString(RsMonth month)
```
    Formats the given month (1st day of month).
    
    Parameters:
    month - date to format
    
    Returns:
    the formatted string (see DATE_FORMATTER())
  - toString
```
public static String toString(byte[] b)
```
    Generates a string presentation of the given bytes.
    
    Parameters:
    b - byte array
    
    Returns:
    string representation (Hex)
  - toString
```
public static String toString(Object[] o)
```
    Generates a string presentation of the given objects.
    
    Parameters:
    o - object array
    
    Returns:
    string representation
  - equals
```
public static boolean equals(Object o1,
             Object o2)
```
    Checks for equality null-safe
    
    Parameters:
    o1 - object 1
    o2 - object 2
    
    Returns:
    true when both values are equal
  - isEmpty
```
public static boolean isEmpty(String s)
```
    Returns true when the given string is null or - when trimmed - empty.
    
    Parameters:
    s - the string to be checked
    
    Returns:
    true when string must be regarded as empty
  - isEmpty
```
public static boolean isEmpty(String s,
              boolean trim)
```
    Returns true when the given string is null empty.
    
    Parameters:
    s - the string to be checked
    trim - whether whitespaces shall be trimmed first
    
    Returns:
    true when string must be regarded as empty
  - getOptions
```
public static String[] getOptions(Class<? extends Enum<?>> clazz)
```
    Returns a list of options for display in default locale.
    
    Parameters:
    clazz - enum class
    
    Returns:
    list of display options
  - getOptions
```
public static String[] getOptions(Class<? extends Enum<?>> clazz,
                  Locale locale)
```
    Returns a list of options for display in given locale.
    
    Parameters:
    clazz - enum class
    locale - locale
    
    Returns:
    list of display options
  - getOptionList
```
public static List<Enum<?>> getOptionList(Class<? extends Enum<?>> clazz)
```
    Returns a list of options from an enumeration class.
    
    Parameters:
    clazz - enum class
    
    Returns:
    list of display options
  - getDisplay
```
public static String getDisplay(Enum<?> e)
```
    Returns the display string for the default locale.
    
    Parameters:
    e - enum value
    
    Returns:
    display
  - getDisplay
```
public static String getDisplay(Enum<?> e,
                Locale locale)
```
    Returns the display string for the given locale.
    
    Parameters:
    e - enum value
    locale - locale
    
    Returns:
    display
  - getEnum
```
public static Enum<?> getEnum(Class<? extends Enum<?>> clazz,
              String display)
```
    Returns the enum constant for given display in default locale.
    
    Parameters:
    clazz - enum class
    display - display of enum
    
    Returns:
    enum constant
  - getEnum
```
public static Enum<?> getEnum(Class<? extends Enum<?>> clazz,
              String display,
              Locale locale)
```
    Returns the enum constant for given display in given locale.
    
    Parameters:
    clazz - enum class
    display - display of enum
    locale - locale
    
    Returns:
    enum constant
  - isCompatibleVersion
```
public static boolean isCompatibleVersion(String minVersion,
                          String maxVersion,
                          String version)
```
    Returns true if version is in range of minVersion and maxVersion. Note that 1.2.0 is greater than 1.2
    
    Parameters:
    minVersion - - minimum required version (can be null)
    maxVersion - - maximum required version (can be null)
    version - - version to check
    
    Returns:
    true when version is within range
  - compareVersion
```
public static int compareVersion(String v1,
                 String v2)
```
    Compares software versions.
    
    Parameters:
    v1 - - version 1
    v2 - - version 2
    
    Returns:
    -1 if v1 < v2, 1 if v1 > v2, 0 if v1 = v2
  - compareVersion
```
public static int compareVersion(String[] v1,
                 String[] v2)
```
    Compares versions.
    
    Parameters:
    v1 - - version 1 divided into separate parts
    v2 - - version 2 divided into separate parts
    
    Returns:
    -1 if v1 < v2, 1 if v1 > v2, 0 if v1 = v2
  - join
```
public static String join(String separator,
          String[] parts)
```
    Makes a join of a string array.
    
    Parameters:
    separator - - the string to be used inbetween parts
    parts - - the parts to join
    
    Returns:
    the joined string
  - join
```
public static String join(String separator,
          String[] parts,
          int startIndex)
```
    Makes a join of a string array.
    
    Parameters:
    separator - - the string to be used inbetween parts
    parts - - the parts to join
    startIndex - - starting index (negative values not allowed)
    
    Returns:
    the joined string
  - join
```
public static String join(String separator,
          String[] parts,
          int startIndex,
          int endIndex)
```
    Makes a join of a string array.
    
    Parameters:
    separator - - the string to be used inbetween parts
    parts - - the parts to join
    startIndex - - starting index (negative values not allowed)
    endIndex - - endIndex (bigger values than number or array elements have no effect)
    
    Returns:
    the joined string
  - debugObject
```
public static String debugObject(Object o)
```
    Recursively debugs objects.
    
    Parameters:
    o - object to debug
    
    Returns:
    the debug string
    Since:
    
    1.2.3
  - debugObject
```
public static void debugObject(StringBuffer s,
               Object o)
```
    Recursively debugs objects and adds this in the string buffer.
    
    Parameters:
    s - string buffer to enhance
    o - object to debug
  - debugObject
```
public static void debugObject(StringBuilder s,
               Object o)
```
    Recursively debugs objects and adds this in the string builder.
    
    Parameters:
    s - string builder to enhance
    o - object to debug
    Since:
    
    1.2.3
  - getUnixTimestamp
```
public static long getUnixTimestamp()
```
    Returns the current time as UNIX timestamp.
    
    Returns:
    time in seconds since January 1st, 1970, 00:00:00 UTC.
  - getUnixTimestamp
```
public static long getUnixTimestamp(Date date)
```
    Returns the given date as UNIX timestamp.
    
    Parameters:
    date - date object.
    
    Returns:
    time in seconds since January 1st, 1970, 00:00:00 UTC.
  - getUnixTimestamp
```
public static long getUnixTimestamp(RsDate date)
```
    Returns the given date as UNIX timestamp.
    
    Parameters:
    date - date object.
    
    Returns:
    time in seconds since January 1st, 1970, 00:00:00 UTC.
  - getUnixTimestamp
```
public static long getUnixTimestamp(long time)
```
    Returns the given Java time as UNIX timestamp.
    
    Parameters:
    time - Java timestamp
    
    Returns:
    time in seconds since January 1st, 1970, 00:00:00 UTC.
  - iterable
```
public static <T> Iterable<T> iterable(Iterator<T> iterator)
```
    Returns an iterable for the given iterator.
    
    Parameters:
    iterator - the iterator to be wrapped
    
    Returns:
    the iterable.
  - getStackTrace
```
public static List<String> getStackTrace(int ignoreLines)
```
    Returns the current stacktrace.
    
    Parameters:
    ignoreLines - the number of lines to be ignored at the top of the trace
    
    Returns:
    the stacktrace
  - stdoutStackTrace
```
public static void stdoutStackTrace()
```
    Dumps the stacktrace so stdout.
  - stderrStackTrace
```
public static void stderrStackTrace()
```
    Dumps the stacktrace so stderr.
  - printStackTrace
```
public static void printStackTrace(PrintStream out,
                   int ignoreLines)
```
    Dumps the stacktrace into the print stream.
    
    Parameters:
    out - the stream to be used
  - errorStackTrace
```
public static void errorStackTrace(Logger log)
```
    Dumps the stacktrace in ERROR mode.
    
    Parameters:
    log - the logger to be used
  - infoStackTrace
```
public static void infoStackTrace(Logger log)
```
    Dumps the stacktrace in INFO mode.
    
    Parameters:
    log - the logger to be used
  - debugStackTrace
```
public static void debugStackTrace(Logger log)
```
    Dumps the stacktrace in DEBUG mode.
    
    Parameters:
    log - the logger to be used
  - traceStackTrace
```
public static void traceStackTrace(Logger log)
```
    Dumps the stacktrace in TRACE mode.
    
    Parameters:
    log - the logger to be used
  - loadProperties
```
public static Properties loadProperties(File file)
                                 throws IOException
```
    Loads a property file.
    
    Parameters:
    file - the file to load
    
    Returns:
    the properties
    
    Throws:
    
    IOException
  - loadProperties
```
public static Properties loadProperties(String file)
                                 throws IOException
```
    Loads a property file.
    
    Parameters:
    file - the file to load
    
    Returns:
    the properties
    
    Throws:
    
    IOException
  - loadProperties
```
public static void loadProperties(Properties props,
                  File file)
                           throws IOException
```
    Loads a property file.
    
    Parameters:
    props - the properties object
    file - the file to load
    
    Throws:
    
    IOException
  - loadProperties
```
public static void loadProperties(Properties props,
                  String file)
                           throws IOException
```
    Loads a property file.
    
    Parameters:
    props - the properties object
    file - the file to load
    
    Throws:
    
    IOException
  - storeProperties
```
public static void storeProperties(Properties props,
                   File file)
                            throws IOException
```
    Stores a property file.
    
    Parameters:
    props - the properties object
    file - the file to load
    
    Throws:
    
    IOException
  - storeProperties
```
public static void storeProperties(Properties props,
                   String file)
                            throws IOException
```
    Stores a property file.
    
    Parameters:
    props - the properties object
    file - the file to load
    
    Throws:
    
    IOException
  - loadContent
```
public static String loadContent(URL url)
                          throws IOException
```
    Loads the content of the URL as a string.
    
    Parameters:
    url - URL to be loaded
    
    Returns:
    the content of the URL
    
    Throws:
    
    IOException - when content of URL cannot be loaded
  - loadContent
```
public static String loadContent(URL url,
                 Charset charset)
                          throws IOException
```
    Loads the content of the URL as a string.
    
    Parameters:
    url - URL to be loaded
    charset - the charset of the content (null for default charset)
    
    Returns:
    the content of the URL
    
    Throws:
    
    IOException - when content of URL cannot be loaded
  - loadContent
```
public static String loadContent(String name)
                          throws IOException
```
    Loads the content of a file as a string.
    
    Parameters:
    name - name of file to be loaded
    
    Returns:
    the content of the file
    
    Throws:
    
    IOException - when content of file cannot be loaded
  - loadContent
```
public static String loadContent(String name,
                 Charset charset)
                          throws IOException
```
    Loads the content of a file as a string.
    
    Parameters:
    name - name of file to be loaded
    charset - the charset of the content (null for default charset)
    
    Returns:
    the content of the file
    
    Throws:
    
    IOException - when content of file cannot be loaded
  - loadContent
```
public static String loadContent(File f)
                          throws IOException
```
    Loads the content of a file as a string.
    
    Parameters:
    f - file to be loaded
    
    Returns:
    the content of the file
    
    Throws:
    
    IOException - when content of file cannot be loaded
  - loadContent
```
public static String loadContent(File f,
                 Charset charset)
                          throws IOException
```
    Loads the content of a file as a string.
    
    Parameters:
    f - file to be loaded
    charset - the charset of the content (null for default charset)
    
    Returns:
    the content of the file
    
    Throws:
    
    IOException - when content of file cannot be loaded
  - loadContent
```
public static String loadContent(InputStream in)
                          throws IOException
```
    Loads the content of a stream as a string.
    
    Parameters:
    in - stream to be loaded
    
    Returns:
    the content of the stream
    
    Throws:
    
    IOException - when content of stream cannot be loaded
  - loadContent
```
public static String loadContent(InputStream in,
                 Charset charset)
                          throws IOException
```
    Loads the content of a stream as a string.
    
    Parameters:
    in - stream to be loaded
    charset - the charset of the content (null for default charset)
    
    Returns:
    the content of the stream
    
    Throws:
    
    IOException - when content of stream cannot be loaded
  - loadContent
```
public static String loadContent(Reader reader)
                          throws IOException
```
    Loads the content of a reader as a string.
    
    Parameters:
    reader - reader to be loaded
    
    Returns:
    the content of the reader
    
    Throws:
    
    IOException - when content of reader cannot be loaded
  - writeContent
```
public static void writeContent(String name,
                String content)
                         throws IOException
```
    Writes the string to a file.
    
    Parameters:
    name - name of file to be written to
    content - the content to be written
    
    Throws:
    
    IOException - when content cannot be written
  - writeContent
```
public static void writeContent(String name,
                String content,
                Charset charset)
                         throws IOException
```
    Writes the string to a file.
    
    Parameters:
    name - name of file to be written to
    content - the content to be written
    charset - the charset of the content (null for default charset)
    
    Throws:
    
    IOException - when content cannot be written
  - writeContent
```
public static void writeContent(File f,
                String content)
                         throws IOException
```
    Writes the string to a file.
    
    Parameters:
    f - file to be written to
    content - the content to be written
    
    Throws:
    
    IOException - when content cannot be written
  - writeContent
```
public static void writeContent(File f,
                String content,
                Charset charset)
                         throws IOException
```
    Writes the string to a file.
    
    Parameters:
    f - file to be written to
    content - the content to be written
    charset - the charset of the content (null for default charset)
    
    Throws:
    
    IOException - when content cannot be written
  - writeContent
```
public static void writeContent(OutputStream out,
                String content)
                         throws IOException
```
    Writes the string to a stream.
    
    Parameters:
    out - stream to be written to
    content - the content to be written
    
    Throws:
    
    IOException - when content cannot be written
  - writeContent
```
public static void writeContent(OutputStream out,
                String content,
                Charset charset)
                         throws IOException
```
    Writes the string to a stream.
    
    Parameters:
    out - stream to be written to
    content - the content to be written
    charset - the charset of the content (null for default charset)
    
    Throws:
    
    IOException - when content cannot be written
  - writeContent
```
public static void writeContent(Writer writer,
                String content)
                         throws IOException
```
    Writes the string to a writer.
    
    Parameters:
    writer - writer to be written to
    content - the content to be written
    
    Throws:
    
    IOException - when content cannot be written
  - isWindows
```
public static boolean isWindows()
```
    Tells whether runtime is a Windows system.
    
    Returns:
    true when OS is a Windows system
  - isMac
```
public static boolean isMac()
```
    Tells whether runtime is a Mac system.
    
    Returns:
    true when OS is a Mac system
  - isUnix
```
public static boolean isUnix()
```
    Tells whether runtime is a Unix system.
    
    Returns:
    true when OS is a Unix system
  - isSolaris
```
public static boolean isSolaris()
```
    Tells whether runtime is a Windows system.
    
    Returns:
    true when OS is a Windows system
  - getOS
```
public static String getOS()
```
    Returns the OS name.
    
    Returns:
    the OS name as returned by System.getProperty("os.name")
  - getDisplay
```
public static String getDisplay(Object o)
```
  - getDisplay
```
public static String getDisplay(Object o,
                Locale locale)
```
    Returns the display string of an object. The method detects IDisplayable, IDisplayProvider and NamedObject.
    
    Parameters:
    o -
    locale - Locale to be used for IDisplayable
    
    Returns:
    a displayable string
  - setAnchor
```
public static URL setAnchor(URL url,
            String anchor)
```
    Set the anchor id for at the given URL.
    
    Parameters:
    url - url to be modified
    anchor - new anchor to be set
    
    Returns:
    the modified URL but other components are kept

Class CommonUtils

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CommonUtils

Method Detail

DATE_FORMATTER

DATE_TIME_FORMATTER

SIMPLE_NUMBER_FORMATTER

SIMPLE_INT_FORMATTER

toString

toString

toString

toString

toString

toString

toString

toString

equals

isEmpty

isEmpty

getOptions

getOptions

getOptionList

getDisplay

getDisplay

getEnum

getEnum

isCompatibleVersion

compareVersion

compareVersion

join

join

join

debugObject

debugObject

debugObject

getUnixTimestamp

getUnixTimestamp

getUnixTimestamp

getUnixTimestamp

iterable

getStackTrace

stdoutStackTrace

stderrStackTrace

printStackTrace

errorStackTrace

infoStackTrace

debugStackTrace

traceStackTrace

loadProperties

loadProperties

loadProperties

loadProperties

storeProperties

storeProperties

loadContent

loadContent

loadContent

loadContent

loadContent

loadContent

loadContent

loadContent

loadContent

writeContent

writeContent

writeContent

writeContent

writeContent

writeContent

writeContent

isWindows

isMac

isUnix

isSolaris

getOS

getDisplay

getDisplay