tfw.base.logging

Class A_LoggingAdapter

java.lang.Object

tfw.base.logging.A_LoggingAdapter

Direct Known Subclasses:

JDKLoggingAdapter, PrintStreamLoggingAdapter

public abstract class A_LoggingAdapter
extends java.lang.Object

Base class of all logging adapters.
Most common logging operations go through logger adapters so that the other parts of the application do not need to know the detail.

Author:

Typhoon.Free.Wolf

Field Summary

Fields

Modifier and Type	Field and Description
private int	intTextDepthOffset
private java.util.Locale	locale
private Level	lowestLevel
private java.lang.Object	oLogger

Constructor Summary

Constructors

Constructor and Description
A_LoggingAdapter(java.lang.Object oLogger, Level lowestMessageLevel, int intTextSpanOffset, java.util.Locale locale)

Method Summary

Modifier and Type	Method and Description
protected int	calculateStackDepth() Calculates the depth of stack.
protected int	calculateTextSpanCount() Calculates the count of text span.
void	changeLocale(java.util.Locale locale) Changes locale.
void	changeLogger(java.lang.Object oLogger) Changes the logger.
void	changeLowestMsgLv(Level lowestLevel) Changes the lowest message level.
void	changeTextDepthOffset(int intTextDepthOffset) Changes the offset of text depth.
protected abstract void	checkLogger(java.lang.Object oLogger) Checks the logger.
protected abstract void	doLog(LogRecord logRecord) Do a single logging.
protected java.lang.String	generateTextSpan() Generates text span.
protected java.util.Locale	getLocale() Gets the locale of adapter.
protected java.lang.Object	getLogger() Gets the logger of adapter.
protected Level	getLowestLevel() Gets the lowest level of adapter.
protected int	getTextDepthOffset() Gets the text depth offset of adapter.
void	log(LogRecord logRecord) Performs logging.
protected void	set(int intTextDepthOffset) Sets the text depth offset to adapter.
protected void	set(Level lowestLevel) Sets the lowest level to adapter.
protected void	set(java.lang.Object oLogger) Sets the logger to adapter.
protected void	setLocale(java.util.Locale locale) Sets the locale to adapter.

Methods inherited from class java.lang.Object

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

Field Detail

oLogger

private java.lang.Object oLogger

locale

private java.util.Locale locale

lowestLevel

private Level lowestLevel

intTextDepthOffset

private int intTextDepthOffset

Constructor Detail

A_LoggingAdapter

public A_LoggingAdapter(java.lang.Object oLogger,
                        Level lowestMessageLevel,
                        int intTextSpanOffset,
                        java.util.Locale locale)
                 throws WrongLoggerTypeException

Parameters:

oLogger - - Logger.

lowestMessageLevel - - Any message that lower than this level would be ignored.

intTextSpanOffset - - Offset of text span.

• Less than 0 means less text span than default.
  
• More than 0 means more text span than default.
  

locale - - Locale.

Throws:

WrongLoggerTypeException - while the type of logger is wrong.

Method Detail

getLogger

protected java.lang.Object getLogger()

Gets the logger of adapter.

Returns:

The logger of adapter.

set

protected void set(java.lang.Object oLogger)

Sets the logger to adapter.

Parameters:

oLogger - - The logger to set to adapter.

getLocale

protected java.util.Locale getLocale()

Gets the locale of adapter.

Returns:

The locale of adapter.

setLocale

protected void setLocale(java.util.Locale locale)

Sets the locale to adapter.

Parameters:

locale - - The locale to set to adapter.

getLowestLevel

protected Level getLowestLevel()

Gets the lowest level of adapter.

Returns:

The lowest level of adapter.

set

protected void set(Level lowestLevel)

Sets the lowest level to adapter.

Parameters:

lowestLevel - - The lowest level to set to adapter.

getTextDepthOffset

protected int getTextDepthOffset()

Gets the text depth offset of adapter.

Returns:

The text depth offset of adapter.

set

protected void set(int intTextDepthOffset)

Sets the text depth offset to adapter.

Parameters:

intTextDepthOffset - - The text depth offset to set to adapter.

changeLowestMsgLv

public final void changeLowestMsgLv(Level lowestLevel)

Changes the lowest message level.

Parameters:

lowestLevel - - Lowest level.

changeLocale

public final void changeLocale(java.util.Locale locale)

Changes locale.

Parameters:

locale - - Locale.

changeTextDepthOffset

public final void changeTextDepthOffset(int intTextDepthOffset)

Changes the offset of text depth.

Parameters:

intTextDepthOffset - - Offset of text depth.

• Smaller than 0 means offset to left.
  
• Larger than 0 means offset to right.
  

changeLogger

public final void changeLogger(java.lang.Object oLogger)
                        throws java.lang.NullPointerException,
                               WrongLoggerTypeException

Changes the logger.

Parameters:

oLogger - - Logger.

Throws:

java.lang.NullPointerException - while logger is null.

WrongLoggerTypeException - while the type of logger is wrong.

log

public final void log(LogRecord logRecord)

Performs logging.

Parameters:

logRecord - - Log record.

calculateStackDepth

protected int calculateStackDepth()

Calculates the depth of stack.

Returns:

Depth of stack.

calculateTextSpanCount

protected int calculateTextSpanCount()

Calculates the count of text span.

Returns:

Count of text span.

generateTextSpan

protected java.lang.String generateTextSpan()

Generates text span.

Returns:

Generated text span.

checkLogger

protected abstract void checkLogger(java.lang.Object oLogger)
                             throws WrongLoggerTypeException

Checks the logger.

Parameters:

oLogger - - Logger.

Throws:

WrongLoggerTypeException - - While a logger adapter found the logger is not the very type that can be handled, the adapter should throw this exception.

doLog

protected abstract void doLog(LogRecord logRecord)

Do a single logging. This method may call a logger, some log handlers and log formatters.

Parameters:

logRecord - - Log record.