tfw.base.logging

Class LogRecord

java.lang.Object

tfw.base.logging.LogRecord

public class LogRecord
extends java.lang.Object

An object of this class contains necessary information to log.

Author:

Typhoon.Free.Wolf

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_TEXT_SPACING
private int	intDistanceFromLogRecordConstructorToTargetMethod
private int	intMethodBorderFlag
private int	intTargetLineNumber
private int	intTotalStackDepth
private Level	level
private long	lngTimeStampMillis
static int	METHOD_FLAG_COMMON
static int	METHOD_FLAG_ENDED
static int	METHOD_FLAG_START
private java.lang.StackTraceElement	ste This thing stores a single group of meta information of the log record.
private java.lang.StackTraceElement[]	ste1d This thing stores all meta information of the log record.
private java.lang.String	strMessage
private java.lang.String	strSourceClassName
private java.lang.String	strTargetClassName "this.getClass().getName()" from the target class. In some cases, the class name in stack trace element array does not match "this.getClass().getName()", so this name need to pass in manually.
private java.lang.String	strTargetFileName
private java.lang.String	strTargetMethodName
private java.lang.String	strTextSpacing
private java.lang.Throwable	tCaught

Constructor Summary

Constructors

Constructor and Description
LogRecord(Level level, java.lang.String strTargetClassName, java.lang.String strMessage, int intDistanceFromLogRecordConstructorToTargetMethod, java.lang.Throwable tCaught, int intMethodBorderFlag)

Method Summary

Modifier and Type	Method and Description
private java.lang.String	dealMessage(java.util.ResourceBundle rb) Deals the message with a resource bundle.
private java.lang.String	generateTextSpan(int intTextSpanCount) Generates the text span.
int	getDistanceFromLogRecordConstructorToTargetMethod() Gets the distance from log record constructor to target method.
java.lang.String	getMessage() Gets message.
Level	getMesssagLevel() Gets message level.
int	getMethodBorderFlag() Gets the flag of method border.
java.lang.String	getSourceClassName() Get the class name where this record TRUELY generated.
java.lang.String	getTargetClassName() Get "this.getClass().getName()" string of the target class. In some cases, the class name in stack trace element array does not match "this.getClass().getName()", so this name need to pass in manually.
java.lang.String	getTargetFileName() Gets the fFile name of target class.
int	getTargetLineNumber() Gets the line number of target file.
java.lang.String	getTargetMethodName() Gets the name of target method.
protected java.lang.String	getTextSpacing() Gets the text spacing.
java.lang.Throwable	getThrowableCaught() Gets the record throwable.
long	getTimeStampMillis() Gets time stamp milliseconds in long form.
int	getTotalStackDepth() Getting total stack depth.
private void	parseStackTraceElements(java.lang.StackTraceElement[] ste1d) Gets the 1d array of stack trace elements.
protected void	resetTextSpacing() Resets the text spacing to the default value.
protected void	setTextSpacing(java.lang.String strTextSpacing) Sets the text spacing.
java.lang.String	toString() Returns a string representation of the object.
java.lang.String	toString(int intTextSpanCount) Returns a string representation of the object.
java.lang.String	toString(int intTextSpanDepth, java.util.Locale locale) Returns a string representation of the object.
java.lang.String	toString(java.util.Locale locale) Returns a string representation of the object.

Methods inherited from class java.lang.Object

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

Field Detail

METHOD_FLAG_COMMON

public static final int METHOD_FLAG_COMMON

See Also:

Constant Field Values

METHOD_FLAG_START

public static final int METHOD_FLAG_START

See Also:

Constant Field Values

METHOD_FLAG_ENDED

public static final int METHOD_FLAG_ENDED

See Also:

Constant Field Values

DEFAULT_TEXT_SPACING

public static final java.lang.String DEFAULT_TEXT_SPACING

See Also:

Constant Field Values

strTextSpacing

private java.lang.String strTextSpacing

level

private Level level

strMessage

private java.lang.String strMessage

intDistanceFromLogRecordConstructorToTargetMethod

private int intDistanceFromLogRecordConstructorToTargetMethod

intTotalStackDepth

private int intTotalStackDepth

lngTimeStampMillis

private long lngTimeStampMillis

tCaught

private java.lang.Throwable tCaught

intMethodBorderFlag

private int intMethodBorderFlag

strTargetClassName

private java.lang.String strTargetClassName

"this.getClass().getName()" from the target class.
In some cases, the class name in stack trace element array does not match "this.getClass().getName()", so this name need to pass in manually.

strSourceClassName

private java.lang.String strSourceClassName

strTargetMethodName

private java.lang.String strTargetMethodName

strTargetFileName

private java.lang.String strTargetFileName

intTargetLineNumber

private int intTargetLineNumber

ste1d

private java.lang.StackTraceElement[] ste1d

This thing stores all meta information of the log record.

ste

private java.lang.StackTraceElement ste

This thing stores a single group of meta information of the log record.

Constructor Detail

LogRecord

public LogRecord(Level level,
                 java.lang.String strTargetClassName,
                 java.lang.String strMessage,
                 int intDistanceFromLogRecordConstructorToTargetMethod,
                 java.lang.Throwable tCaught,
                 int intMethodBorderFlag)

Parameters:

level - - Record level.

strTargetClassName - - "this.getClass().getName()" of the target class.
In some cases, the class name in stack trace element array does not match "this.getClass().getName()", so this name need to pass in manually.

strMessage - - Record message.

intDistanceFromLogRecordConstructorToTargetMethod - - Distance of depth form [the target method who wants to create a log record] to [the constructor of this log record], so that the distance can be fixed.
- The value would be auto limited to 0 while it is less than 0.

intMethodBorderFlag - - An integer flag to indicates whether this log record is generated at the border of a method.

tCaught - - Throwable to record.

Method Detail

getTextSpacing

protected java.lang.String getTextSpacing()

Gets the text spacing.

Returns:

The text spacing.

setTextSpacing

protected void setTextSpacing(java.lang.String strTextSpacing)

Sets the text spacing.

Parameters:

strTextSpacing - - The text spacing.

resetTextSpacing

protected void resetTextSpacing()

Resets the text spacing to the default value.

getMesssagLevel

public Level getMesssagLevel()

Gets message level.

Returns:

Message level.

getMessage

public java.lang.String getMessage()

Gets message.

Returns:

Message.

getDistanceFromLogRecordConstructorToTargetMethod

public int getDistanceFromLogRecordConstructorToTargetMethod()

Gets the distance from log record constructor to target method.

Returns:

The distance from log record constructor to target method.

getTotalStackDepth

public int getTotalStackDepth()

Getting total stack depth.

Returns:

Total depth of stack.

getTimeStampMillis

public long getTimeStampMillis()

Gets time stamp milliseconds in long form.

Returns:

Long number of time stamp.

getThrowableCaught

public java.lang.Throwable getThrowableCaught()

Gets the record throwable.

Returns:

Record throwable.

getMethodBorderFlag

public int getMethodBorderFlag()

Gets the flag of method border.

Returns:

An integer flag to indicates whether this log record is generated at the border of a method.

getTargetClassName

public java.lang.String getTargetClassName()

Get "this.getClass().getName()" string of the target class.
In some cases, the class name in stack trace element array does not match "this.getClass().getName()", so this name need to pass in manually.

Returns:

The "this.getClass().getName()" string of the target class.

getSourceClassName

public java.lang.String getSourceClassName()

Get the class name where this record TRUELY generated.

Returns:

The class name where this record TRUELY generated.

getTargetMethodName

public java.lang.String getTargetMethodName()

Gets the name of target method.

Returns:

Name of target method.

getTargetFileName

public java.lang.String getTargetFileName()

Gets the fFile name of target class.

Returns:

File name of target class.

getTargetLineNumber

public int getTargetLineNumber()

Gets the line number of target file.

Returns:

Line number of target file.

parseStackTraceElements

private void parseStackTraceElements(java.lang.StackTraceElement[] ste1d)

Gets the 1d array of stack trace elements.

Parameters:

ste1d - - 1d array of stack trace elements.

toString

public java.lang.String toString()

Returns a string representation of the object.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the object.

See Also:

Object.toString()

toString

public java.lang.String toString(int intTextSpanCount)

Returns a string representation of the object.

Parameters:

intTextSpanCount - - Count of text span.

Returns:

A string representation of the object, with appointed count of text span.

toString

public java.lang.String toString(java.util.Locale locale)

Returns a string representation of the object.

Parameters:

locale - - Locale.

Returns:

A localized string representation of the object.

toString

public java.lang.String toString(int intTextSpanDepth,
                                 java.util.Locale locale)

Returns a string representation of the object.

Parameters:

intTextSpanDepth - - Depth of text span.

locale - - Locale.

Returns:

A localized string representation of the object, with appointed depth of text span.

dealMessage

private java.lang.String dealMessage(java.util.ResourceBundle rb)

Deals the message with a resource bundle.

Parameters:

rb - - Resource bundle.

Returns:

Message.

generateTextSpan

private java.lang.String generateTextSpan(int intTextSpanCount)

Generates the text span.

Parameters:

intTextSpanCount - - Count of text span.

Returns:

Text span.