ifs.fnd.service

Class Util

java.lang.Object

ifs.fnd.service.Util

public final class Util
extends java.lang.Object

Common class with diverse utility functions. TODO:There are a lot of methods in this class which look very suspicious. Why do they still exist? Some are only used by fndweb. Better move them there.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEBUG
static boolean	JAVA_COMPRESS

Method Summary

Modifier and Type	Method and Description
static int	canonicalHashKey(java.lang.String text) Computes a hash key on a canonical (OS independent) form of a text.
static java.lang.String	compress(java.lang.String str) Compress a string.
static java.lang.String	compress(java.lang.String src, java.lang.StringBuffer dest) Compress a string.
static java.lang.String	compressJava(java.lang.String str) Compress a string.
static java.lang.String	compressJava(java.lang.String str, boolean addHeader) Compress a string.
static void	debug(java.lang.String s) Deprecated.
static java.lang.String	firstLine(java.lang.String text) Deprecated. Moved to class ifs.fnd.util.Str
static java.lang.String	formatDuration(long durationMillis) Format time duration as a string using format "[days:]HH:mm:ss.SSS".
static java.lang.String	formatElapsedTime(long milliseconds) Format time showing separately hours, minutes and seconds.
static java.lang.String	formatMessage(java.lang.String message, java.lang.Object... p) Deprecated. Moved to class ifs.fnd.util.Str
static byte[]	fromBase64Text(java.lang.String text) Perform the BASE64 decoding of the specified string.
static byte[]	fromHexText(java.lang.String text) Transform a hexadecimal string into an array of bytes.
static java.text.NumberFormat	getIntegerFormat() Get a new number formatter suitable for big integer numbers.
static java.lang.String	getShortDescription(java.lang.Throwable t) Returns short description of a Throwable.
static java.lang.String	getShortMessage(java.lang.Throwable t) Returns short message from a Throwable.
static java.lang.String	getStackTrace(java.lang.Throwable t) Returns the current stack formatted as one String.
static void	initClass(java.lang.Class cls) Forces the initialization of a class.
static boolean	isDebugEnabled() Check if debugging is enabled.
static boolean	isDebugEnabled(java.lang.String className) Check if debugging of a specific class is enabled.
static boolean	isTraceFileDebugEnabled() Check if debug text should be written to the trace file.
static java.lang.String	lpad(java.lang.String str, int length) Deprecated. Moved to class ifs.fnd.util.Str
static java.lang.String	lpad(java.lang.String str, int length, char ch) Deprecated. Moved to class ifs.fnd.util.Str
static <E> java.util.ArrayList<E>	newArrayList() Factory method for generic ArrayList.
static <E> java.util.ArrayList<E>	newArrayList(int initialCapacity) Factory method for generic ArrayList.
static <K,V> java.util.HashMap<K,V>	newHashMap() Factory method for generic HashMap.
static <K,V> java.util.HashMap<K,V>	newHashMap(int initialCapacity) Factory method for generic HashMap.
static <E> java.util.HashSet<E>	newHashSet() Factory method for generic HashSet.
static <K,V> java.util.LinkedHashMap<K,V>	newLinkedHashMap() Factory method for generic LinkedHashMap.
static <E> java.util.LinkedHashSet<E>	newLinkedHashSet() Factory method for generic LinkedHashSet.
static <E> SimpleStack<E>	newSimpleStack() Factory method for generic SimpleStack.
static <K,V> java.util.TreeMap<K,V>	newTreeMap() Factory method for generic TreeMap.
static <E> java.util.TreeSet<E>	newTreeSet() Factory method for generic TreeSet.
static java.lang.String	readAndTrimFile(java.lang.String filename) Deprecated. Moved to the new utility class ifs.fnd.util.IoUtil
static java.lang.String	rpad(java.lang.String str, int length) Deprecated. Moved to class ifs.fnd.util.Str
static java.lang.String	rpad(java.lang.String str, int length, char ch) Deprecated. Moved to class ifs.fnd.util.Str
static void	showException(java.lang.Throwable t) Output the details of the specified exception to standard output.
static java.lang.String	toBase64Text(byte[] data) Perform the BASE64 encoding of the specified array of bytes.
static java.lang.String	toHexText(byte[] data) Transform an array of bytes into its hexadecimal representation.
static java.lang.String	trimLine(java.lang.String value) Deprecated. Moved to class ifs.fnd.util.Str
static java.lang.String	uncompress(java.lang.String str) Uncompress a string.
static java.lang.String	uncompress(java.lang.String src, java.lang.StringBuffer dest) Uncompress a string.
static java.lang.String	uncompressJava(java.lang.String str) Uncompress a string.
static void	writeFile(java.lang.String filename, java.lang.String str) Deprecated. Moved to the new utility class ifs.fnd.util.IoUtil

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEBUG

public static final boolean DEBUG

JAVA_COMPRESS

public static final boolean JAVA_COMPRESS

See Also:

Constant Field Values

Method Detail

debug

public static void debug(java.lang.String s)

Deprecated.

Show text inside the Windows debug console (DBMON.EXE).

Parameters:

s - a text to print to the console

compress

public static java.lang.String compress(java.lang.String str)
                                 throws FndException,
                                        java.io.IOException,
                                        java.util.zip.ZipException

Compress a string.

Parameters:

str - a string to compress

Returns:

the compressed string

Throws:

FndException

java.io.IOException

java.util.zip.ZipException

uncompress

public static java.lang.String uncompress(java.lang.String str)
                                   throws FndException,
                                          java.io.IOException,
                                          java.util.zip.ZipException

Uncompress a string.

Parameters:

str - a string to uncompress

Returns:

the original (uncompressed) string

Throws:

FndException

java.io.IOException

java.util.zip.ZipException

compress

public static java.lang.String compress(java.lang.String src,
                                        java.lang.StringBuffer dest)
                                 throws FndException,
                                        java.io.IOException,
                                        java.util.zip.ZipException

Compress a string.

Parameters:

src - a string to compress

dest - destination buffer

Returns:

the compressed string

Throws:

FndException

java.io.IOException

java.util.zip.ZipException

uncompress

public static java.lang.String uncompress(java.lang.String src,
                                          java.lang.StringBuffer dest)
                                   throws FndException,
                                          java.io.IOException,
                                          java.util.zip.ZipException

Uncompress a string.

Parameters:

src - a compressed string

Returns:

the original (uncompressed) string

Throws:

FndException

java.io.IOException

java.util.zip.ZipException

compressJava

public static java.lang.String compressJava(java.lang.String str)
                                     throws java.io.IOException,
                                            java.util.zip.ZipException

Compress a string.

Parameters:

str - a string to compress

Returns:

the compressed string

Throws:

java.io.IOException

java.util.zip.ZipException

compressJava

public static java.lang.String compressJava(java.lang.String str,
                                            boolean addHeader)
                                     throws java.io.IOException,
                                            java.util.zip.ZipException

Compress a string.

Parameters:

str - a string to compress

Returns:

the compressed string

Throws:

java.io.IOException

java.util.zip.ZipException

uncompressJava

public static java.lang.String uncompressJava(java.lang.String str)
                                       throws java.io.IOException,
                                              java.util.zip.ZipException

Uncompress a string.

Parameters:

str - a compressed string

Returns:

the original (uncompressed) string

Throws:

java.io.IOException

java.util.zip.ZipException

toBase64Text

public static java.lang.String toBase64Text(byte[] data)
                                     throws java.io.IOException

Perform the BASE64 encoding of the specified array of bytes.

Throws:

java.io.IOException

fromBase64Text

public static byte[] fromBase64Text(java.lang.String text)
                             throws java.io.IOException

Perform the BASE64 decoding of the specified string.

Throws:

java.io.IOException

toHexText

public static java.lang.String toHexText(byte[] data)

Transform an array of bytes into its hexadecimal representation.

fromHexText

public static byte[] fromHexText(java.lang.String text)

Transform a hexadecimal string into an array of bytes.

isDebugEnabled

public static boolean isDebugEnabled(java.lang.String className)

Check if debugging of a specific class is enabled.

isDebugEnabled

public static boolean isDebugEnabled()

Check if debugging is enabled.

isTraceFileDebugEnabled

public static boolean isTraceFileDebugEnabled()

Check if debug text should be written to the trace file.

initClass

public static void initClass(java.lang.Class cls)

Forces the initialization of a class.

Parameters:

cls - the class to initialize

formatElapsedTime

public static java.lang.String formatElapsedTime(long milliseconds)

Format time showing separately hours, minutes and seconds.

Parameters:

milliseconds - the number of milliseconds to format

Returns:

a String in the format: "... hours ... minutes ... seconds"

formatDuration

public static java.lang.String formatDuration(long durationMillis)

Format time duration as a string using format "[days:]HH:mm:ss.SSS". The first part representing days is omitted if the number of days is equal to 0.

Parameters:

durationMillis - the duration to format

Returns:

the time as a String

getIntegerFormat

public static java.text.NumberFormat getIntegerFormat()

Get a new number formatter suitable for big integer numbers.

Returns:

a new instance of DecimalFormat that uses space as grouping separator.

canonicalHashKey

public static int canonicalHashKey(java.lang.String text)

Computes a hash key on a canonical (OS independent) form of a text.

Parameters:

text - a text to compute the hash key on

Returns:

hash key

newHashSet

public static <E> java.util.HashSet<E> newHashSet()

Factory method for generic HashSet.

Type Parameters:

E - the type of set elements

Returns:

new instance of parameterized HashSet

newTreeSet

public static <E> java.util.TreeSet<E> newTreeSet()

Factory method for generic TreeSet.

Type Parameters:

E - the type of set elements

Returns:

new instance of parameterized TreeSet

newLinkedHashSet

public static <E> java.util.LinkedHashSet<E> newLinkedHashSet()

Factory method for generic LinkedHashSet.

Type Parameters:

E - the type of set elements

Returns:

new instance of parameterized LinkedHashSet

newHashMap

public static <K,V> java.util.HashMap<K,V> newHashMap()

Factory method for generic HashMap.

Type Parameters:

K - the type of map keys

V - the type of map values

Returns:

new instance of parameterized HashMap

newHashMap

public static <K,V> java.util.HashMap<K,V> newHashMap(int initialCapacity)

Factory method for generic HashMap.

Type Parameters:

K - the type of map keys

V - the type of map values

Parameters:

initialCapacity - the initial capacity of the list

Returns:

new instance of parameterized HashMap

newTreeMap

public static <K,V> java.util.TreeMap<K,V> newTreeMap()

Factory method for generic TreeMap.

Type Parameters:

K - the type of map keys

V - the type of map values

Returns:

new instance of parameterized TreeMap

newLinkedHashMap

public static <K,V> java.util.LinkedHashMap<K,V> newLinkedHashMap()

Factory method for generic LinkedHashMap.

Type Parameters:

K - the type of map keys

V - the type of map values

Returns:

new instance of parameterized LinkedHashMap

newArrayList

public static <E> java.util.ArrayList<E> newArrayList()

Factory method for generic ArrayList.

Type Parameters:

E - the type of array elements

Returns:

new instance of parameterized ArrayList

newArrayList

public static <E> java.util.ArrayList<E> newArrayList(int initialCapacity)

Factory method for generic ArrayList.

Type Parameters:

E - the type of array elements

Parameters:

initialCapacity - the initial capacity of the list

Returns:

new instance of parameterized ArrayList

newSimpleStack

public static <E> SimpleStack<E> newSimpleStack()

Factory method for generic SimpleStack.

Type Parameters:

E - the type of stack elements

Returns:

new instance of parameterized SimpleStack

getStackTrace

public static java.lang.String getStackTrace(java.lang.Throwable t)

Returns the current stack formatted as one String.

Parameters:

t - a Throwable

Returns:

the stack trace for the specified Throwable

getShortDescription

public static java.lang.String getShortDescription(java.lang.Throwable t)

Returns short description of a Throwable. Works similar to Throwable.toString() with the exception that the message is limited to 512 characters and/or one line. Message shorter then 512 characters will remain unchanged. Is the message longer, only the first line will be taken. Is the line longer then 512 characters, it will be truncated.

Parameters:

t - Throwable to extract description from

Returns:

short description

getShortMessage

public static java.lang.String getShortMessage(java.lang.Throwable t)

Returns short message from a Throwable. Works similar to Throwable.getLocalizedMessage() with the exception that the message is limited to 512 characters and/or one line. Message shorter then 512 characters will remain unchanged. Is the message longer, only the first line will be taken. Is the line longer then 512 characters, it will be truncated.

Parameters:

t - Throwable to extract message from

Returns:

short message

showException

public static void showException(java.lang.Throwable t)

Output the details of the specified exception to standard output.

Parameters:

t - an exception

readAndTrimFile

public static java.lang.String readAndTrimFile(java.lang.String filename)
                                        throws FndException

Deprecated. Moved to the new utility class ifs.fnd.util.IoUtil

Read the file with the specified name, remove trailing blanks from every line, and return the resulting contents as one String.

Parameters:

filename - a file name

Returns:

the file contents

Throws:

FndException

See Also:

IoUtil.readAndTrimFile(java.lang.String)

writeFile

public static void writeFile(java.lang.String filename,
                             java.lang.String str)
                      throws java.io.IOException

Deprecated. Moved to the new utility class ifs.fnd.util.IoUtil

Writes an UTF-8 converted string to a file.

Parameters:

filename - file name

str - file contents

Throws:

java.io.IOException

See Also:

IoUtil.writeFile(java.lang.String, java.lang.String)

formatMessage

public static java.lang.String formatMessage(java.lang.String message,
                                             java.lang.Object... p)

Deprecated. Moved to class ifs.fnd.util.Str

Formats message that can contain up to nine optional parameters referred as &1 to &9.

See Also:

Str.formatMessage(java.lang.String, java.lang.Object[])

lpad

public static java.lang.String lpad(java.lang.String str,
                                    int length)

Deprecated. Moved to class ifs.fnd.util.Str

Return given string left-padded with blanks to the specified length.

See Also:

Str.lpad(java.lang.String, int)

lpad

public static java.lang.String lpad(java.lang.String str,
                                    int length,
                                    char ch)

Deprecated. Moved to class ifs.fnd.util.Str

Return given string left-padded to the specified length.

See Also:

Str.lpad(java.lang.String, int, char)

rpad

public static java.lang.String rpad(java.lang.String str,
                                    int length)

Deprecated. Moved to class ifs.fnd.util.Str

Return given string rigth-padded with blanks to the specified length.

See Also:

Str.rpad(java.lang.String, int)

rpad

public static java.lang.String rpad(java.lang.String str,
                                    int length,
                                    char ch)

Deprecated. Moved to class ifs.fnd.util.Str

Return given string rigth-padded to the specified length.

See Also:

Str.rpad(java.lang.String, int, char)

trimLine

public static java.lang.String trimLine(java.lang.String value)

Deprecated. Moved to class ifs.fnd.util.Str

Remove trailing whitespace from a string.

Parameters:

value - a string to trim

Returns:

a copy of the specified string with trailing whitespace omitted

See Also:

Str.trimLine(java.lang.String)

firstLine

public static java.lang.String firstLine(java.lang.String text)

Deprecated. Moved to class ifs.fnd.util.Str

Return the first line from the specified text. This method uses a StringTokenizer to find the first line of the text.

Parameters:

text - a text

Returns:

the first line from the specified text

See Also:

Str.firstLine(java.lang.String)