com.dkfqs.tools.lib

Class Utils

java.lang.Object

com.dkfqs.tools.lib.Utils

public class Utils
extends java.lang.Object

Various utilities. All methods are static.

Field Summary

Fields

Modifier and Type	Field and Description
static java.text.SimpleDateFormat	RESULT_FILENAME_FRAGMENT_DATE_FORMAT A simple date format with the pattern "yyyy-MM-dd@HH-mm-ss".
static java.text.SimpleDateFormat	SIMPLE_DATE_FORMAT A simple date format with the pattern "yyyy-MM-dd HH:mm:ss".
static java.text.SimpleDateFormat	SIMPLE_DATE_FORMAT_WITH_MILLIS A simple date format with the pattern "yyyy-MM-dd HH:mm:ss.SSS".
static java.text.SimpleDateFormat	SOURCE_FILE_DATE_FORMAT A simple date format with the pattern "dd MMM yyyy HH:mm:ss".

Method Summary

Modifier and Type	Method and Description
static int	binaryIndex(byte[] src, byte[] pattern) Get the index of a binary pattern within binary data.
static int	binaryIndex(byte[] data, byte[] searchFragment, int offset) Search inside binary data for a fragment of data, starting at a specific offset.
static java.lang.String	bytesToHex(byte[] bytes) Convert a byte array to a hex string.
static int	caseInsensitiveIndexOf(java.lang.String text, java.lang.String search) Perform a case-insensitive 'index of'.
static java.lang.String	formatTimestamp(long timestamp) Format an absolute date and time to a string.
static java.lang.String	formatTimestamp(java.util.TimeZone timeZone, long timestamp) Format an absolute date and time to a string by using a specific time zone.
static java.lang.String	formatTimestampInSourceFileFormat(long timestamp) Format an absolute date and time to a string in 'source file date format'.
static java.lang.String	formatTimestampInSourceFileFormat(java.util.TimeZone timeZone, long timestamp) Format an absolute date and time to a string in 'source file date format' by using a specific time zone.
static java.lang.String	formatTimestampResultFileNameFragmentFormat(long timestamp) Format an absolute date and time to a string in 'result file name fragment format'.
static java.lang.String	formatTimestampResultFileNameFragmentFormat(java.util.TimeZone timeZone, long timestamp) Format an absolute date and time to a string in 'result file name fragment format' by using a specific time zone.
static java.lang.String	formatTimestampWithMillis(long timestamp) Format an absolute date and time to a string which includes also milliseconds.
static java.lang.String	formatTimestampWithMillis(java.util.TimeZone timeZone, long timestamp) Format an absolute date and time to a string which includes also milliseconds by using a specific time zone.
static java.lang.String	getCurrentTimeZoneAsString() Get the current time zone and offset as string.
static java.util.TimeZone	getDefaultTimeZone() Get the default time zone.
static java.util.List<java.lang.String>	getStackTraceLines(java.lang.Throwable throwable) Get the lines of a stack trace.
static java.lang.String	getStrippedFileName(java.io.File file) Get from a file the file name without extension
static java.lang.String	getThrowableMessage(java.lang.Throwable throwable, java.lang.String defaultMessage) Get the message of a throwable.
static byte[]	gUnZip(byte[] b) Decompress a byte array which was compressed by the GZIP algorithm.
static byte[]	inflate(byte[] b) Inflate a byte array which was compressed by the ZLIB algorithm.
static boolean	is90HumanReadableASCII(byte[] bytes) Get if the content of a byte[] array contains at least 90% human readable ASCII chars.
static boolean	isFormalValidVariableName(java.lang.String variableName) Verify if the name of a variable is formal valid.
static boolean	isUTF8(byte[] pText, boolean supportBinaryCut) Get if the content of a byte[] array is in UTF-8 data format.
static void	main(java.lang.String[] args) Internal test program.
static boolean	matchToWildcardString(java.lang.String checkString, java.lang.String wildcardString) Check if a text string mach to another text string which contains one ore more wildcard chars.
static java.util.List<byte[]>	splitByteArray(byte[] b, int chunkSize) Split a byte array into a list of chunks.
static java.util.List<byte[]>	splitByteArrayToFragments(byte[] b, int numberOfFragments) Split a byte array into a number of fragments.
static java.lang.String	stripFileExtension(java.lang.String fileName) Get from a file name with extension the file name without extension

Methods inherited from class java.lang.Object

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

Field Detail

SIMPLE_DATE_FORMAT

public static final java.text.SimpleDateFormat SIMPLE_DATE_FORMAT

A simple date format with the pattern "yyyy-MM-dd HH:mm:ss".

SIMPLE_DATE_FORMAT_WITH_MILLIS

public static final java.text.SimpleDateFormat SIMPLE_DATE_FORMAT_WITH_MILLIS

A simple date format with the pattern "yyyy-MM-dd HH:mm:ss.SSS".

SOURCE_FILE_DATE_FORMAT

public static final java.text.SimpleDateFormat SOURCE_FILE_DATE_FORMAT

A simple date format with the pattern "dd MMM yyyy HH:mm:ss".

RESULT_FILENAME_FRAGMENT_DATE_FORMAT

public static final java.text.SimpleDateFormat RESULT_FILENAME_FRAGMENT_DATE_FORMAT

A simple date format with the pattern "yyyy-MM-dd@HH-mm-ss".

Method Detail

formatTimestamp

public static java.lang.String formatTimestamp(long timestamp)

Format an absolute date and time to a string.

Parameters:

timestamp - the absolute date and time (Unix time)

Returns:

the formatted string

See Also:

SIMPLE_DATE_FORMAT

formatTimestamp

public static java.lang.String formatTimestamp(java.util.TimeZone timeZone,
                                               long timestamp)

Format an absolute date and time to a string by using a specific time zone.

Parameters:

timeZone - the time zone

timestamp - the absolute date and time (Unix time)

Returns:

the formatted string

See Also:

SIMPLE_DATE_FORMAT

formatTimestampWithMillis

public static java.lang.String formatTimestampWithMillis(long timestamp)

Format an absolute date and time to a string which includes also milliseconds.

Parameters:

timestamp - the absolute date and time (Unix time)

Returns:

the formatted string

See Also:

SIMPLE_DATE_FORMAT_WITH_MILLIS

formatTimestampWithMillis

public static java.lang.String formatTimestampWithMillis(java.util.TimeZone timeZone,
                                                         long timestamp)

Format an absolute date and time to a string which includes also milliseconds by using a specific time zone.

Parameters:

timeZone - the time zone

timestamp - the absolute date and time (Unix time)

Returns:

the formatted string

See Also:

SIMPLE_DATE_FORMAT_WITH_MILLIS

formatTimestampInSourceFileFormat

public static java.lang.String formatTimestampInSourceFileFormat(long timestamp)

Format an absolute date and time to a string in 'source file date format'.

Parameters:

timestamp - the absolute date and time (Unix time)

Returns:

the formatted string

See Also:

SOURCE_FILE_DATE_FORMAT

formatTimestampInSourceFileFormat

public static java.lang.String formatTimestampInSourceFileFormat(java.util.TimeZone timeZone,
                                                                 long timestamp)

Format an absolute date and time to a string in 'source file date format' by using a specific time zone.

Parameters:

timeZone - the time zone

timestamp - the absolute date and time (Unix time)

Returns:

the formatted string

See Also:

SOURCE_FILE_DATE_FORMAT

formatTimestampResultFileNameFragmentFormat

public static java.lang.String formatTimestampResultFileNameFragmentFormat(long timestamp)

Format an absolute date and time to a string in 'result file name fragment format'.

Parameters:

timestamp - the absolute date and time (Unix time)

Returns:

the formatted string

See Also:

RESULT_FILENAME_FRAGMENT_DATE_FORMAT

formatTimestampResultFileNameFragmentFormat

public static java.lang.String formatTimestampResultFileNameFragmentFormat(java.util.TimeZone timeZone,
                                                                           long timestamp)

Format an absolute date and time to a string in 'result file name fragment format' by using a specific time zone.

Parameters:

timeZone - the time zone

timestamp - the absolute date and time (Unix time)

Returns:

the formatted string

See Also:

RESULT_FILENAME_FRAGMENT_DATE_FORMAT

getDefaultTimeZone

public static java.util.TimeZone getDefaultTimeZone()

Get the default time zone.

Returns:

the default time zone

getCurrentTimeZoneAsString

public static java.lang.String getCurrentTimeZoneAsString()

Get the current time zone and offset as string.

Returns:

the current time zone and offset as string, example: "Central European Time +02:00"

getStackTraceLines

public static java.util.List<java.lang.String> getStackTraceLines(java.lang.Throwable throwable)

Get the lines of a stack trace.

Parameters:

throwable - the throwable

Returns:

a list of strings which contains the lines of the stack trace.

getThrowableMessage

public static java.lang.String getThrowableMessage(java.lang.Throwable throwable,
                                                   java.lang.String defaultMessage)

Get the message of a throwable.

Parameters:

throwable - the throwable

defaultMessage - the returned message if the throwable has no message

Returns:

the message of the throwable, or the default message

matchToWildcardString

public static boolean matchToWildcardString(java.lang.String checkString,
                                            java.lang.String wildcardString)

Check if a text string mach to another text string which contains one ore more wildcard chars. The following wildcard chars are supported:

• '?' = wildcard for one char
• '*' = wildcard for multiple chars

Parameters:

checkString - the string to check

wildcardString - the matching string which can contain wildcards '?' and/or '*'

Returns:

true if the string to check matches to the string which contains the wildcards

gUnZip

public static byte[] gUnZip(byte[] b)
                     throws java.io.IOException

Decompress a byte array which was compressed by the GZIP algorithm.

Parameters:

b - the byte array to decompress

Returns:

the decompressed data

Throws:

java.io.IOException - if the decompression fails

inflate

public static byte[] inflate(byte[] b)
                      throws java.io.IOException

Inflate a byte array which was compressed by the ZLIB algorithm.

Parameters:

b - the byte array to inflate

Returns:

the inflated data

Throws:

java.io.IOException - if the inflation fails

caseInsensitiveIndexOf

public static int caseInsensitiveIndexOf(java.lang.String text,
                                         java.lang.String search)

Perform a case-insensitive 'index of'.

Parameters:

text - the text

search - the search fragment

Returns:

the offset of the search fragment, or -1 if the search fragment was not found.

binaryIndex

public static int binaryIndex(byte[] src,
                              byte[] pattern)

Get the index of a binary pattern within binary data.

Parameters:

src - the binary data

pattern - the binary pattern

Returns:

the index or -1 if the pattern was not found

binaryIndex

public static int binaryIndex(byte[] data,
                              byte[] searchFragment,
                              int offset)

Search inside binary data for a fragment of data, starting at a specific offset.

Parameters:

data - the binary data

searchFragment - the fragment to search

offset - the offset where the search starts inside the binary data (0..n-1)

Returns:

the index where the search fragment was found, or -1 if the search fragment was not found, and also -1 if the length of the search fragment is zero.

is90HumanReadableASCII

public static boolean is90HumanReadableASCII(byte[] bytes)

Get if the content of a byte[] array contains at least 90% human readable ASCII chars.

Parameters:

bytes - the array of bytes

Returns:

if the content of a byte[] array contains at least 90% human readable ASCII chars

isUTF8

public static boolean isUTF8(byte[] pText,
                             boolean supportBinaryCut)

Get if the content of a byte[] array is in UTF-8 data format.

Parameters:

pText - the byte[] array to check

supportBinaryCut - if true, don't check the last 4 bytes of the byte[] array, in order that also binary cuts of UTF-8 data fragments are supported

Returns:

true if the content of the byte[] array is in UTF-8 data format

See https://stackoverflow.com/questions/28890907/implement-a-function-to-check-if-a-string-byte-array-follows-utf-8-format?lq=1

splitByteArray

public static java.util.List<byte[]> splitByteArray(byte[] b,
                                                    int chunkSize)

Split a byte array into a list of chunks.

Parameters:

b - the byte array to split

chunkSize - the maximum size of a chunk in bytes

Returns:

the list of chunks

splitByteArrayToFragments

public static java.util.List<byte[]> splitByteArrayToFragments(byte[] b,
                                                               int numberOfFragments)

Split a byte array into a number of fragments. Not that the result list may contain fewer elements than the passed number of fragments.

Parameters:

b - the byte array to split

numberOfFragments - the number of fragments

Returns:

a list of split byte[] fragments

isFormalValidVariableName

public static boolean isFormalValidVariableName(java.lang.String variableName)

Verify if the name of a variable is formal valid. The name of a variable can contain only letters (a-z , A-Z), numeric digits (0-9) or the underscore character (_). The first character of a variable name must be a letter (a-z, A-Z) or underscore (_).

Parameters:

variableName - the name of the variable

Returns:

true if the name of the variable is formal valid

stripFileExtension

public static java.lang.String stripFileExtension(java.lang.String fileName)

Get from a file name with extension the file name without extension

Parameters:

fileName - the file name with extension

Returns:

the file name without extension

getStrippedFileName

public static java.lang.String getStrippedFileName(java.io.File file)

Get from a file the file name without extension

Parameters:

file - the file

Returns:

the file name without extension

bytesToHex

public static java.lang.String bytesToHex(byte[] bytes)

Convert a byte array to a hex string.

Parameters:

bytes - the byte array to convert

Returns:

the hex string of the byte array in uppercase chars

main

public static void main(java.lang.String[] args)

Internal test program.

Parameters:

args - {no args}