Package com.ibm.websphere.ras
Class DataFormatHelper
- java.lang.Object
-
- com.ibm.websphere.ras.DataFormatHelper
-
public class DataFormatHelper extends java.lang.Object
Utilities which provide formatting for date strings (NCSA compliant dates used in trace records), and padded thread ids, etc.
-
-
Constructor Summary
Constructors Constructor Description DataFormatHelper()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static java.lang.String
escape(java.lang.String src)
Escapes characters in the input string that would interfere with formattingstatic java.lang.String
formatCurrentTime()
Return the current time formatted as dd/MMM/yyyy HH:mm:ss:SSS Zstatic java.lang.String
formatTime(long timestamp)
Return the given time formatted as dd/MMM/yyyy HH:mm:ss:SSS Zstatic java.lang.String
formatTime(long timestamp, boolean useIsoDateFormat)
Return the given time formatted, based on the provided format structurestatic java.lang.String
getThreadId()
Get and return the thread id, padded to 8 characters.static java.lang.String
getThreadId(java.lang.Thread thread)
Get and return the thread id, padded to 8 characters.static java.lang.String
identityToString(java.lang.Object o)
Returns a string containing a concise, human-readable description of the object.static java.lang.String
padHexString(int num, int width)
Returns the provided integer, padded to the specified number of characters with zeros.static java.lang.String
sensitiveToString(java.lang.Object o)
Returns a string containing a concise, human-readable description of the object.static java.lang.String
throwableToString(java.lang.Throwable t)
Returns a string containing the formatted exception stack
-
-
-
Method Detail
-
identityToString
public static java.lang.String identityToString(java.lang.Object o)
Returns a string containing a concise, human-readable description of the object. The string is the same as the one that would be returned by Object.toString even if the object's class has overriden the toString or hashCode methods. The return value for a null object is null.- Parameters:
o
- the object- Returns:
- the string representation
-
sensitiveToString
public static java.lang.String sensitiveToString(java.lang.Object o)
Returns a string containing a concise, human-readable description of the object. The result is similar toidentityToString(java.lang.Object)
but indicates that the contents of the object are masked because they are sensitive.- Parameters:
o
- the object- Returns:
- a string representation
-
formatCurrentTime
public static final java.lang.String formatCurrentTime()
Return the current time formatted as dd/MMM/yyyy HH:mm:ss:SSS Z- Returns:
- formated date string
-
formatTime
public static final java.lang.String formatTime(long timestamp)
Return the given time formatted as dd/MMM/yyyy HH:mm:ss:SSS Z- Parameters:
timestamp
- A timestamp as a long, e.g. what would be returned fromSystem.currentTimeMillis()
- Returns:
- formated date string
-
formatTime
public static final java.lang.String formatTime(long timestamp, boolean useIsoDateFormat)
Return the given time formatted, based on the provided format structure- Parameters:
timestamp
- A timestamp as a long, e.g. what would be returned fromSystem.currentTimeMillis()
useIsoDateFormat
- A boolean, if true, the given date and time will be formatted in ISO-8601, e.g. yyyy-MM-dd'T'HH:mm:ss.SSSZ if false, the date and time will be formatted as the current locale,- Returns:
- formated date string
-
getThreadId
public static final java.lang.String getThreadId()
Get and return the thread id, padded to 8 characters.- Returns:
- 8 character string representation of thread id
-
getThreadId
public static final java.lang.String getThreadId(java.lang.Thread thread)
Get and return the thread id, padded to 8 characters.- Parameters:
thread
- the specified thread- Returns:
- the string representation of the thread id
-
padHexString
public static final java.lang.String padHexString(int num, int width)
Returns the provided integer, padded to the specified number of characters with zeros.- Parameters:
num
- Input number as an integerwidth
- Number of characters to return, including padding- Returns:
- input number as zero-padded string
-
throwableToString
public static final java.lang.String throwableToString(java.lang.Throwable t)
Returns a string containing the formatted exception stack- Parameters:
t
- throwable- Returns:
- formatted exception stack as a string
-
escape
public static final java.lang.String escape(java.lang.String src)
Escapes characters in the input string that would interfere with formatting- Parameters:
src
- input string to be escaped- Returns:
- escaped string
-
-