org.safs.tools.stringutils

Class StringUtilities

java.lang.Object

org.safs.tools.stringutils.StringUtilities

Direct Known Subclasses:

StringUtils

public abstract class StringUtilities
extends java.lang.Object

Author:

Jack

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StringUtilities.TestStacktraceCaller

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DATE_FORMAT_a
static java.lang.String	DATE_FORMAT_AM_PM_DATE_TIME
static java.lang.String	DATE_FORMAT_AM_PM_TIME
static java.lang.String	DATE_FORMAT_DATE
static java.lang.String	DATE_FORMAT_MILITARY_DATE_TIME
static java.lang.String	DATE_FORMAT_MILITARY_TIME
static java.lang.String	FILE_TIME_BASE
static java.lang.String	JAVA_TIME_BASE
static int	SAFS_DEFAULT_START_INDEX The default start index, it is 1
static java.lang.String	TIME_OF_AM
static java.lang.String	TIME_OF_PM
static long	TimeBaseDifferenceFromFileTimeToJavaTimeInMillisecond TimeBaseDifferenceFromFileTimeToJavaTimeInMillisecond contains the difference from filetime to javatime in millisecond, it is initialized in the static code of this class.

Constructor Summary

Constructors

Constructor and Description
StringUtilities()

Method Summary

Modifier and Type	Method and Description
static boolean	charIsInRange(char c, int beg, int end) Method charIsInRange.
static boolean	convertBool(java.lang.Object bool) Returns a boolean value based on value of bool.
static java.lang.Integer	convertToInteger(java.lang.String value)
static java.lang.String	current(boolean isMilitary)
static java.lang.String	debugmsg(boolean fullQualified)
static java.lang.String	debugmsg(java.lang.Class<?> clazz, java.lang.String methodName) Generate debug message with class name and method name.
static java.lang.String	debugmsg(java.lang.Class<?> clazz, java.lang.String methodName, java.lang.String message) Generate debug message with class name, method name and message.
static java.lang.String	debugmsg(java.lang.Class<?> clazz, java.lang.String methodName, java.lang.String message, java.lang.Throwable e) Generate debug message with class name, method name, detail message and Throwable object.
static java.lang.String	debugmsg(java.lang.Class<?> clazz, java.lang.String methodName, java.lang.Throwable e) Generate debug message with class name, method name and Throwable object.
static java.lang.String	debugmsg(java.lang.Throwable e)
static java.lang.String	findAndReplace(java.lang.String input, java.lang.String search, java.lang.String replace) Replace all instances of search string with the replace string.
static java.awt.Rectangle	formRectangle(java.lang.String rectangleString, java.lang.String separator)
static boolean	getBoolean(java.util.Map<?,?> map, java.lang.String key) Get a boolean value from the map according to the key. If it doesn't exist in map, the SAFSException will be thrown out.
static java.lang.String	getCallerClassName(boolean fullQualified)
static java.lang.String	getCallerID(boolean fullQualified) Get my caller's id, which is a string containing 'full-qualified-callername'+'current-thread-id',
static java.lang.String	getCallerName(boolean fullQualified)
static java.lang.String	getClassName(int level, boolean fullQualified) Get the class name, or class-name of its caller, or class-name of its caller's caller etc. this depends on the parameter 'level'.
static java.lang.String	getCurrentMethodName(boolean fullQualified)
static java.util.Date	getDate(java.lang.String date, java.lang.String dateFormat) Note According to the dateFormat, use the SimpleDateFormat to convert a string to java.util.Date
static java.lang.String	getDateString(java.util.Date date) Note With dateFormat "MM-dd-yyyy", use the SimpleDateFormat to convert the date object to string
static java.lang.String	getDateString(java.util.Date date, java.lang.String dateFormat) Note According to the dateFormat, use the SimpleDateFormat to convert the date object to string
static java.lang.String	getDateTimeString(java.util.Date date, boolean isMilitary) Note Use the SimpleDateFormat to convert the date object to string, keep both the date and the time part
static double	getDouble(java.util.Map<?,?> map, java.lang.String key) Get a double value from the map according to the key. If it doesn't exist in map, the SAFSException will be thrown out.
static float	getFloat(java.util.Map<?,?> map, java.lang.String key) Get a float value from the map according to the key. If it doesn't exist in map, the SAFSException will be thrown out.
static int	getIndex(java.lang.String index) Parse a string to get an integer index.
static int	getIndex(java.lang.String index, int baseIndex) Parse a string to get an integer index.
static int	getInteger(java.util.Map<?,?> map, java.lang.String key) Get an int value from the map according to the key. If it doesn't exist in map, the SAFSException will be thrown out.
static long	getLong(java.util.Map<?,?> map, java.lang.String key) Get a long value from the map according to the key. If it doesn't exist in map, the SAFSException will be thrown out.
static java.lang.String	getMethodName(int level, boolean fullQualified) Get the method name, or its caller's name, or its caller's caller's name etc. this depends on the parameter 'level'.
static java.lang.Number	getNumber(java.util.Map<?,?> map, java.lang.String key, java.lang.Class<?> numberClass) Warn: If the key can't be found in the map object, a SAFSException will be thrown out
static int	getNumSubstrings(java.lang.String strSub, java.lang.String strText) Method getNumSubstrings.
static java.lang.StackTraceElement	getStackTraceElement(int level) To get the current method information or its caller or its ancestor dynamically, we can refer to the StackTrace, which is a stack recording the methods' invocation trace.
static java.lang.String	getString(java.util.Map<?,?> map, java.lang.String key) Get a String value from the map according to the key. If it doesn't exist in map, the SAFSException will be thrown out.
static java.util.Vector	getSubStrings(java.lang.String strText) Method getSubStrings.
static java.util.Vector	getSubStrings(java.lang.String strText, java.util.Vector vQuoteLocs) Method getSubStrings.
static java.lang.String	getTimeString(java.util.Date date, boolean isMilitary) Note Use the SimpleDateFormat to convert the date object to string, just keep the time part
static java.lang.Object	getValue(java.util.Map<?,?> map, java.lang.String key) Get a Object value from the map according to the key. If it doesn't exist in map, the SAFSException will be thrown out.
static boolean	isLegalVarName(java.lang.String strVarName) Method isLegalVarName.
static boolean	isQuoted(java.lang.String strText, int location) Method isQuoted.
static boolean	isQuoted(java.lang.String strText, int location, java.util.Vector vQuoteLocs) Method isQuoted.
static boolean	isValidNonStdChar(char c) Method isValidNonStdChar.
static int	locateNextNonWhiteSpace(java.lang.String strSearch, int ipos) Method locateNextNonWhiteSpace.
static int	locateNextSubstring(java.lang.String strSearch, java.lang.String strFind, int ipos) Method locateNextSubstring.
static int	locateNextUnquotedNonWhiteSpace(java.lang.String strSearch, int ipos) Method locateNextUnquotedNonWhiteSpace.
static int	locateNextUnquotedSingleChar(java.lang.String strSearch, java.lang.String strChars, int ipos) Method locateNextUnquotedSingleChar.
static int	locateNextUnquotedSingleChar(java.lang.String strSearch, java.lang.String strChars, int ipos, java.util.Vector vQuoteLocs) Method locateNextUnquotedSingleChar.
static int	locateNextUnquotedSubstring(java.lang.String strSearch, java.lang.String strFind, int ipos) Method locateNextUnquotedSubstring.
static int	locateNextUnquotedSubstring(java.lang.String strSearch, java.lang.String strFind, int ipos, java.util.Vector vQuoteLocs) Method locateNextUnquotedSubstring.
static java.util.Vector	locateQuotedSubStrings(java.lang.String strText) Method locateQuotedSubStrings.
static java.lang.String	LTWhitespace(java.lang.String strValue) Method LTWhitespace.
static void	main(java.lang.String[] args) java -ea org.safs.tools.stringutils.StringUtilities
static boolean	nextCharIsDQ(java.lang.String strText, int location) Method nextCharIsDQ.
static int	parseIndex(java.lang.String index) Parse a string to get an integer index.
static int	parseIndex(java.lang.String index, int baseIndex) Parse a string to get an integer index.
static java.lang.String	removeAllNonQuotedWhitespace(java.lang.String strValue) Method removeAllNonQuotedWhitespace.
static java.lang.String	removeAllNonQuotedWhitespace(java.lang.String strValue, java.util.Vector vQuoteLocs) Method removeAllNonQuotedWhitespace.
static java.lang.String	removeDoubleQuotes(java.lang.String original) Remove any leading and\or trailing double quotes.
static java.lang.String	removePrefix(java.lang.String original, java.lang.String prefix) Remove the prefix from the original string, and return the result
static java.lang.String	removeRelativeFilePathPrefix(java.lang.String relativepath) Attempts to remove ".\", "./", "\", or "/" relative path prefixes from the provided String.
static java.lang.String	removeSingleQuotes(java.lang.String original) Remove any leading and\or trailing single quotes.
static java.lang.String	removeSuffix(java.lang.String original, java.lang.String suffix) Remove the suffix from the original string, and return the result
static java.lang.String	replaceString(java.lang.String strSearch, java.lang.String strReplace, int ibegin, int iend) Method replaceString.
static java.lang.String	reverse(java.lang.String s) Method reverse.
static java.lang.String	RTWhitespace(java.lang.String strValue) Method RTWhitespace.
static void	sleep(int milliseconds)
static java.lang.String	spacePad(int ipad) Method spacePad.
static java.lang.String	TWhitespace(java.lang.String strValue) Method TWhitespace.

Methods inherited from class java.lang.Object

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

Field Detail

DATE_FORMAT_DATE

public static final java.lang.String DATE_FORMAT_DATE

See Also:

Constant Field Values

DATE_FORMAT_MILITARY_TIME

public static final java.lang.String DATE_FORMAT_MILITARY_TIME

See Also:

Constant Field Values

DATE_FORMAT_MILITARY_DATE_TIME

public static final java.lang.String DATE_FORMAT_MILITARY_DATE_TIME

See Also:

Constant Field Values

DATE_FORMAT_a

public static final java.lang.String DATE_FORMAT_a

See Also:

Constant Field Values

DATE_FORMAT_AM_PM_TIME

public static final java.lang.String DATE_FORMAT_AM_PM_TIME

See Also:

Constant Field Values

DATE_FORMAT_AM_PM_DATE_TIME

public static final java.lang.String DATE_FORMAT_AM_PM_DATE_TIME

See Also:

Constant Field Values

TIME_OF_AM

public static final java.lang.String TIME_OF_AM

See Also:

Constant Field Values

TIME_OF_PM

public static final java.lang.String TIME_OF_PM

See Also:

Constant Field Values

JAVA_TIME_BASE

public static final java.lang.String JAVA_TIME_BASE

See Also:

Constant Field Values

FILE_TIME_BASE

public static final java.lang.String FILE_TIME_BASE

See Also:

Constant Field Values

TimeBaseDifferenceFromFileTimeToJavaTimeInMillisecond

public static long TimeBaseDifferenceFromFileTimeToJavaTimeInMillisecond

 TimeBaseDifferenceFromFileTimeToJavaTimeInMillisecond contains the difference from
 filetime to javatime in millisecond, it is initialized in the static code of this class.

 FileTime is a class defined in org.safs.natives.win32.Kernel32
 FileTime contains a 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC/GMT).
 FileTime's unit: 100 nanosecond
 FileTime's base: January 1, 1601 00:00:00 (UTC/GMT)

 JavaTime represents a point in time that is time milliseconds after January 1, 1970 00:00:00 (UTC/GMT).
 JavaTime's unit: millisecond
 JavaTime's base: January 1, 1970 00:00:00 (UTC/GMT)

 1, 000, 000 nanoseconds = 1 millisecond

 As the unit and the base-time are different for FileTime and JavaTime, a conversion is needed.

 How to convert?
 Convert from FileTime to JavaTime:
 javatime = filetime/10000 - TimeBaseDifferenceFromFileTimeToJavaTimeInMillisecond

 Convert from JavaTime to FileTime:
 filetime = (javatime+TimeBaseDifferenceFromFileTimeToJavaTimeInMillisecond)*10000
 

See Also:

Kernel32.FileTime, NativeWrapper.convertFileTimeToJavaTime(org.safs.natives.win32.Kernel32.FileTime), JAVA_TIME_BASE, FILE_TIME_BASE, DATE_FORMAT_MILITARY_DATE_TIME

SAFS_DEFAULT_START_INDEX

public static final int SAFS_DEFAULT_START_INDEX

The default start index, it is 1

See Also:

Constant Field Values

Constructor Detail

StringUtilities

public StringUtilities()

Method Detail

LTWhitespace

public static java.lang.String LTWhitespace(java.lang.String strValue)

Method LTWhitespace. Remove whitespace (space and tab chars) from start of strings

Parameters:

strValue - String to remove leading whitespace (space and tab)

Returns:

strValue without leading whitespace

RTWhitespace

public static java.lang.String RTWhitespace(java.lang.String strValue)

Method RTWhitespace. Remove whitespace (space and tab chars) from end of strings

Parameters:

strValue - String to remove trailing whitespace (space and tab)

Returns:

strValue without trailing whitespace

TWhitespace

public static java.lang.String TWhitespace(java.lang.String strValue)

Method TWhitespace. Remove whitespace (space and tab chars) from start and end of strings

Parameters:

strValue - String to remove whitespace (space and tab)

Returns:

strValue without leading or trailing whitespace

charIsInRange

public static boolean charIsInRange(char c,
                                    int beg,
                                    int end)

Method charIsInRange. Return boolean T/F specifying wheather char is numerically between integers beg and end. ( c >= beg && c <= end )

Parameters:

c - character to check

beg - lower end of range

end - higher end of range

Returns:

boolean

getNumSubstrings

public static int getNumSubstrings(java.lang.String strSub,
                                   java.lang.String strText)

Method getNumSubstrings. Returns the number of occurances of strSub within strText as an integer

Parameters:

strSub - substring to count occurances

strText - string to search for strSub occurances

Returns:

int

nextCharIsDQ

public static boolean nextCharIsDQ(java.lang.String strText,
                                   int location)

Method nextCharIsDQ. Return boolean T/F specifying wheather or not the character in strText at location+1 is a double quote (")

Parameters:

strText - String to check

location - int location to start check

Returns:

boolean

locateQuotedSubStrings

public static java.util.Vector locateQuotedSubStrings(java.lang.String strText)

Method locateQuotedSubStrings. Return a Vector that contains Integer objects whose intValue specifies the location of a double quote (") in strText. Note that double quotes must be paired so there should be an even number of Integer objects withing the returned Vector.

Parameters:

strText - String in which to locate the quoted substrings

Returns:

Vector

isQuoted

public static boolean isQuoted(java.lang.String strText,
                               int location)

Method isQuoted. Return boolean T/F specifying wheather or not the string within strText at int location is quoted (within double quotes)

Parameters:

strText - String to check

location - Location to check

Returns:

boolean

isQuoted

public static boolean isQuoted(java.lang.String strText,
                               int location,
                               java.util.Vector vQuoteLocs)

Method isQuoted. Return boolean T/F specifying wheather or not the string within strText at int location is quoted (within double quotes)

Parameters:

strText - String to check

location - Location to check

vQuoteLocs - Vector containing Integer objects whose intValue specifies the location of a double quote (") in strText.

Returns:

boolean

getSubStrings

public static java.util.Vector getSubStrings(java.lang.String strText)

Method getSubStrings. Return a Vector containing String objects that are quoted substrings within strText

Parameters:

strText - The string to find substrings

Returns:

Vector

getSubStrings

public static java.util.Vector getSubStrings(java.lang.String strText,
                                             java.util.Vector vQuoteLocs)

Method getSubStrings. Return a Vector containing String objects that are quoted substrings within strText

Parameters:

strText - The string to find substrings

vQuoteLocs - Vector containing Integer objects whose intValue specifies the location of a double quote (") in strText.

Returns:

Vector

locateNextUnquotedNonWhiteSpace

public static int locateNextUnquotedNonWhiteSpace(java.lang.String strSearch,
                                                  int ipos)

Method locateNextUnquotedNonWhiteSpace. Return an int containing the location in strSearch after ipos where the first non-quoted, non-whitespace character is

Parameters:

strSearch -

ipos -

Returns:

int

locateNextNonWhiteSpace

public static int locateNextNonWhiteSpace(java.lang.String strSearch,
                                          int ipos)

Method locateNextNonWhiteSpace. Return an int containing the location in strSearch after ipos where the first non whitespace character is

Parameters:

strSearch -

ipos -

Returns:

int

locateNextUnquotedSingleChar

public static int locateNextUnquotedSingleChar(java.lang.String strSearch,
                                               java.lang.String strChars,
                                               int ipos)

Method locateNextUnquotedSingleChar. Return the integer location within strSearch that is first occurance of any of the characters making up strChars

Parameters:

strSearch - The string to search

strChars - A string consisting of single characters to find the first occurance of

ipos - int position within strSearch to begin search

Returns:

int

locateNextUnquotedSingleChar

public static int locateNextUnquotedSingleChar(java.lang.String strSearch,
                                               java.lang.String strChars,
                                               int ipos,
                                               java.util.Vector vQuoteLocs)

Method locateNextUnquotedSingleChar. Return the integer location within strSearch that is first occurance of any of the characters making up strChars

Parameters:

strSearch - The string to search

strChars - A string consisting of single characters to find the first occurance of

ipos - int position within strSearch to begin search

vQuoteLocs - Vector containing Integer objects whose intValue specifies the location of a double quote (") in strText.

Returns:

int

locateNextUnquotedSubstring

public static int locateNextUnquotedSubstring(java.lang.String strSearch,
                                              java.lang.String strFind,
                                              int ipos)

Method locateNextUnquotedSubstring. Return the integer location within strSearch that is first occurance of substring strFind

Parameters:

strSearch - The string to search

strFind - The substring to search for

ipos - int position within strSearch to begin search

Returns:

int

locateNextUnquotedSubstring

public static int locateNextUnquotedSubstring(java.lang.String strSearch,
                                              java.lang.String strFind,
                                              int ipos,
                                              java.util.Vector vQuoteLocs)

Method locateNextUnquotedSubstring. Return the integer location within strSearch that is first occurance of substring strFind

Parameters:

strSearch - The string to search

strFind - The substring to search for

ipos - int position within strSearch to begin search

vQuoteLocs - Vector containing Integer objects whose intValue specifies the location of a double quote (") in strText.

Returns:

int

locateNextSubstring

public static int locateNextSubstring(java.lang.String strSearch,
                                      java.lang.String strFind,
                                      int ipos)

Method locateNextSubstring. Return the integer location within strSearch that is first occurance of substring strFind

Parameters:

strSearch - The string to search

strFind - The substring to search for

ipos - int position within strSearch to begin search

Returns:

int

removeAllNonQuotedWhitespace

public static java.lang.String removeAllNonQuotedWhitespace(java.lang.String strValue)

Method removeAllNonQuotedWhitespace. Return a String that is strValue with all non quoted whitespace (space and tab) removed. (keeps whitespace between double quotes)

Parameters:

strValue - The string to remove non-quoted whitespace

Returns:

String

removeAllNonQuotedWhitespace

public static java.lang.String removeAllNonQuotedWhitespace(java.lang.String strValue,
                                                            java.util.Vector vQuoteLocs)

Method removeAllNonQuotedWhitespace. Return a String that is strValue with all non quoted whitespace (space and tab) removed. (keeps whitespace between double quotes)

Parameters:

strValue - The string to remove non-quoted whitespace

vQuoteLocs - Vector containing Integer objects whose intValue specifies the location of a double quote (") in strText.

Returns:

String

replaceString

public static java.lang.String replaceString(java.lang.String strSearch,
                                             java.lang.String strReplace,
                                             int ibegin,
                                             int iend)

Method replaceString. Return a strSearch with strReplace inserted over the locations from ibegin to iend

Parameters:

strSearch - The string to search

strReplace - The replacement string

ibegin - int location to begin replacement

iend - int location to end replacement

Returns:

String

reverse

public static java.lang.String reverse(java.lang.String s)

Method reverse. Return string s with the characters making it up from right to left

Parameters:

s - The string to reverse

Returns:

String

isLegalVarName

public static boolean isLegalVarName(java.lang.String strVarName)

Method isLegalVarName. Return a boolean T/F specifying wheather or not strVarName is a legal variable name within SAFS

Parameters:

strVarName - The variable name to test

Returns:

boolean

isValidNonStdChar

public static boolean isValidNonStdChar(char c)

Method isValidNonStdChar. Return boolean T/F specifying wheather or not the char c is a valid non standard character for SAFS variable names

Parameters:

c - The char to test

Returns:

boolean

findAndReplace

public static java.lang.String findAndReplace(java.lang.String input,
                                              java.lang.String search,
                                              java.lang.String replace)

Replace all instances of search string with the replace string. This is for pre-Java 1.4

spacePad

public static java.lang.String spacePad(int ipad)

Method spacePad. Returns a string consisting of spaces of length ipad

Parameters:

ipad -

Returns:

String

convertBool

public static boolean convertBool(java.lang.Object bool)

Returns a boolean value based on value of bool. Returns true if bool is "YES", "TRUE", "ON", "1" or "-1". Uses bool.equalsIgnoreCase...

Parameters:

bool -

Returns:

boolean

getBoolean

public static boolean getBoolean(java.util.Map<?,?> map,
                                 java.lang.String key)
                          throws SAFSException

Get a boolean value from the map according to the key.
If it doesn't exist in map, the SAFSException will be thrown out.

Throws:

SAFSException

getValue

public static java.lang.Object getValue(java.util.Map<?,?> map,
                                        java.lang.String key)
                                 throws SAFSException

Get a Object value from the map according to the key.
If it doesn't exist in map, the SAFSException will be thrown out.

Throws:

SAFSException

getString

public static java.lang.String getString(java.util.Map<?,?> map,
                                         java.lang.String key)
                                  throws SAFSException

Get a String value from the map according to the key.
If it doesn't exist in map, the SAFSException will be thrown out.

Throws:

SAFSException

getInteger

public static int getInteger(java.util.Map<?,?> map,
                             java.lang.String key)
                      throws SAFSException

Get an int value from the map according to the key.
If it doesn't exist in map, the SAFSException will be thrown out.

Throws:

SAFSException

getFloat

public static float getFloat(java.util.Map<?,?> map,
                             java.lang.String key)
                      throws SAFSException

Get a float value from the map according to the key.
If it doesn't exist in map, the SAFSException will be thrown out.

Throws:

SAFSException

getDouble

public static double getDouble(java.util.Map<?,?> map,
                               java.lang.String key)
                        throws SAFSException

Get a double value from the map according to the key.
If it doesn't exist in map, the SAFSException will be thrown out.

Throws:

SAFSException

getLong

public static long getLong(java.util.Map<?,?> map,
                           java.lang.String key)
                    throws SAFSException

Get a long value from the map according to the key.
If it doesn't exist in map, the SAFSException will be thrown out.

Throws:

SAFSException

getNumber

public static java.lang.Number getNumber(java.util.Map<?,?> map,
                                         java.lang.String key,
                                         java.lang.Class<?> numberClass)
                                  throws SAFSException

Warn: If the key can't be found in the map object, a SAFSException will be thrown out

Throws:

SAFSException

removeRelativeFilePathPrefix

public static java.lang.String removeRelativeFilePathPrefix(java.lang.String relativepath)

Attempts to remove ".\", "./", "\", or "/" relative path prefixes from the provided String. Does not alter the path if File.isAbsolute returns TRUE.

Example:

".\Datapool\Filename.ext" returns "Datapool\Filename.ext"

Parameters:

relativepath - String filepath to strip of leading relative path prefix characters.

Returns:

the String stripped of any relative path prefix characters, if any. Returns null if the provided String is null. Returns an empty String if the provided String is empty.

removePrefix

public static java.lang.String removePrefix(java.lang.String original,
                                            java.lang.String prefix)

Remove the prefix from the original string, and return the result

Example:

original = "^filename=c:\file.txt" , prefix="^filename=" the result will be "c:\file.txt"

Parameters:

original -

prefix -

Returns:

removeSuffix

public static java.lang.String removeSuffix(java.lang.String original,
                                            java.lang.String suffix)

Remove the suffix from the original string, and return the result

Example:

original = "^filename=c:\file.txt" , suffix="=c:\file.txt" the result will be "^filename"

Parameters:

original -

suffix -

Returns:

removeDoubleQuotes

public static java.lang.String removeDoubleQuotes(java.lang.String original)

Remove any leading and\or trailing double quotes.

Example:

original = "c:\file.txt" (with quotes) the result will be 'c:\file.txt' (no quotes at all)

Parameters:

original -

Returns:

removeSingleQuotes

public static java.lang.String removeSingleQuotes(java.lang.String original)

Remove any leading and\or trailing single quotes.

Example:

original = 'c:\file.txt' (with quotes) the result will be 'c:\file.txt' (no quotes at all)

Parameters:

original -

Returns:

convertToInteger

public static java.lang.Integer convertToInteger(java.lang.String value)
                                          throws SAFSException

Parameters:

value - A string represents an integer value.

Returns:

An integer converted from string

Throws:

SAFSException

formRectangle

public static java.awt.Rectangle formRectangle(java.lang.String rectangleString,
                                               java.lang.String separator)

Parameters:

rectangleString - A string represent a rectangle: x, y , widht, height.

separator - The separator in rectangleString to separate x y width and height

Returns:

A java Rectangle object, constructed by rectangleString

getDateString

public static java.lang.String getDateString(java.util.Date date,
                                             java.lang.String dateFormat)

Note According to the dateFormat, use the SimpleDateFormat to convert the date object to string

Parameters:

date - A java.util.Date object

dateFormat - A string represents the date format pattern of SimpleDateFormat

Returns:

A string represents the Date object

getDateString

public static java.lang.String getDateString(java.util.Date date)

Note With dateFormat "MM-dd-yyyy", use the SimpleDateFormat to convert the date object to string

Parameters:

date - A java.util.Date object

Returns:

A string represents the Date object's date part

getTimeString

public static java.lang.String getTimeString(java.util.Date date,
                                             boolean isMilitary)

Note Use the SimpleDateFormat to convert the date object to string, just keep the time part

Parameters:

date - A java.util.Date object

isMilitary - A boolean, if true, convert to a military time (24 hours format)

Returns:

A string represents the Date object's time part

getDateTimeString

public static java.lang.String getDateTimeString(java.util.Date date,
                                                 boolean isMilitary)

Note Use the SimpleDateFormat to convert the date object to string, keep both the date and the time part

Parameters:

date - A java.util.Date object

isMilitary - A boolean, if true, convert to a military time (24 hours format)

Returns:

A string represents the Date object

current

public static java.lang.String current(boolean isMilitary)

Parameters:

isMilitary - boolean, true to return date-time in format DATE_FORMAT_MILITARY_DATE_TIME;
otherwise in format DATE_FORMAT_AM_PM_DATE_TIME

Returns:

String, the current date-time string of format DATE_FORMAT_AM_PM_DATE_TIME or DATE_FORMAT_MILITARY_DATE_TIME

parseIndex

public static int parseIndex(java.lang.String index)

Parse a string to get an integer index. If the string index is not an
integer or it is smaller than 1, then the result will be 1.

Parameters:

index - String, the index given as a string

Returns:

int, an integer index, it is 1-based

See Also:

parseIndex(String, int), getIndex(String)

parseIndex

public static int parseIndex(java.lang.String index,
                             int baseIndex)

Parse a string to get an integer index. If the string index is not an
integer or it is smaller than the 'base index', then the 'base index'
will be returned.

Parameters:

index - String, the index given as a string

baseIndex - int, the base index

Returns:

int, an integer index.

See Also:

getIndex(String, int)

getIndex

public static int getIndex(java.lang.String index)
                    throws SAFSException

Parse a string to get an integer index.

Parameters:

index - String, the index given as a string

Returns:

int, an integer index, it is 1-based

Throws:

SAFSException - If the string index is not an integer or it is smaller than the SAFS_DEFAULT_START_INDEX

See Also:

getIndex(String, int), parseIndex(String)

getIndex

public static int getIndex(java.lang.String index,
                           int baseIndex)
                    throws SAFSException

Parse a string to get an integer index.

Parameters:

index - String, the index given as a string

baseIndex - int, the base index

Returns:

int, an integer index.

Throws:

SAFSException - If the string index is not an integer or it is smaller than the 'base index'

See Also:

parseIndex(String, int)

getDate

public static java.util.Date getDate(java.lang.String date,
                                     java.lang.String dateFormat)

Note According to the dateFormat, use the SimpleDateFormat to convert a string to java.util.Date

Parameters:

date - A string represents a date.

dateFormat - A string represents the date format pattern of SimpleDateFormat

Returns:

A java.util.Date object

sleep

public static void sleep(int milliseconds)

Parameters:

milliseconds - int, milliseconds to sleep

debugmsg

public static java.lang.String debugmsg(java.lang.Throwable e)

debugmsg

public static java.lang.String debugmsg(java.lang.Class<?> clazz,
                                        java.lang.String methodName)

Generate debug message with class name and method name.

Parameters:

clazz - Class, the class object of the instance, which is caller of the method.

methodName - String, the string name of the method.

Returns:

String, debug massage, for example "org.safs.IndependantLog.debug(): "

debugmsg

public static java.lang.String debugmsg(java.lang.Class<?> clazz,
                                        java.lang.String methodName,
                                        java.lang.String message)

Generate debug message with class name, method name and message.

Parameters:

clazz - Class, the class object of the instance, which is caller of the method.

methodName - String, the string name of the method.

message - String, the detail message for the debug IndependantLog.

Returns:

String, debug massage, for example "org.safs.IndependantLog.debug(): Something is wrong."

debugmsg

public static java.lang.String debugmsg(java.lang.Class<?> clazz,
                                        java.lang.String methodName,
                                        java.lang.Throwable e)

Generate debug message with class name, method name and Throwable object.

Parameters:

clazz - Class, the class object of the instance, which is caller of the method.

methodName - String, the string name of the method.

e - Throwable, the Throwable object rose when calling method.

Returns:

String, debug massage, for example "org.safs.IndependantLog.debug(): SomeException:Exception message."

debugmsg

public static java.lang.String debugmsg(java.lang.Class<?> clazz,
                                        java.lang.String methodName,
                                        java.lang.String message,
                                        java.lang.Throwable e)

Generate debug message with class name, method name, detail message and Throwable object.

Parameters:

clazz - Class, the class object of the instance, which is caller of the method.

methodName - String, the string name of the method.

message - String, the detail message for the debug IndependantLog.

e - Throwable, the Throwable object rose when calling method.

Returns:

String, debug massage, for example "org.safs.IndependantLog.debug(): Something is wrong:SomeException:Exception message."

debugmsg

public static java.lang.String debugmsg(boolean fullQualified)

Parameters:

fullQualified - boolean, true if the returned method name should be full-qualified.

Returns:

String, "my method name"+"(): "

See Also:

getMethodName(int, boolean)

getCurrentMethodName

public static java.lang.String getCurrentMethodName(boolean fullQualified)

Parameters:

fullQualified - boolean, true if the returned method name should be full qualified.

Returns:

String, my method name

See Also:

getMethodName(int, boolean)

getCallerName

public static java.lang.String getCallerName(boolean fullQualified)

Parameters:

fullQualified - boolean, true if the returned method name should be full qualified.

Returns:

String, my caller's method name

See Also:

getMethodName(int, boolean)

getCallerClassName

public static java.lang.String getCallerClassName(boolean fullQualified)

Parameters:

fullQualified - boolean, true if the returned class name should be full qualified.

Returns:

String, my caller's class name

See Also:

getClassName(int, boolean)

getCallerID

public static java.lang.String getCallerID(boolean fullQualified)

Get my caller's id, which is a string containing 'full-qualified-callername'+'current-thread-id',

Parameters:

fullQualified - boolean, true if the returned method name should be full qualified.

Returns:

String, my caller's id

See Also:

getMethodName(int, boolean)

getMethodName

public static java.lang.String getMethodName(int level,
                                             boolean fullQualified)

Get the method name, or its caller's name, or its caller's caller's name etc.
this depends on the parameter 'level'. level=0, the method calling 'org.safs.StringUtils.getMethodName' level=1, the method calling the method at level 0 level=2, the method calling the method at level 1 ...

Parameters:

level - int, the level in the StackTrace.

fullQualified - boolean, true if the returned name should be full qualified.

Returns:

String, the method name.

See Also:

getStackTraceElement(int)

getClassName

public static java.lang.String getClassName(int level,
                                            boolean fullQualified)

Get the class name, or class-name of its caller, or class-name of its caller's caller etc.
this depends on the parameter 'level'. level=0, the class name in which a method calling the method 'org.safs.StringUtils.getClassName' level=1, the class name in which a method calling the method at level 0 level=2, the class name in which a method calling the method at level 1 ...

Parameters:

level - int, the level in the StackTrace.

fullQualified - boolean, true if the returned name should be full qualified.

Returns:

String, the class name.

See Also:

getStackTraceElement(int)

getStackTraceElement

public static java.lang.StackTraceElement getStackTraceElement(int level)

 To get the current method information or its caller or its ancestor dynamically,
 we can refer to the StackTrace, which is a stack recording the methods' invocation trace.
 The current thread trace of this method is as following:
 ...
 java.lang.Thread.getStackTrace
 org.safs.tools.stringutils.StringUtilities.getStackTraceElement
 level=0, Here is the method, who calls StringUtilities.getStackTraceElement()
 level=1, Here is the direct caller of method at level 0
 level=2, Here is the direct caller of method at level 1
 ...

 We can supply the parameter 'level' to this method, and we can get the appropriate StackTraceElement.

 

Parameters:

level - int, the level in the StackTrace under 'org.safs.tools.stringutils.StringUtilities.getStackTraceElement'

Returns:

StackTraceElement, it contains the information of method, class, file etc.

main

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

java -ea org.safs.tools.stringutils.StringUtilities

Parameters:

args -