com.dkfqs.tools.logging

Class CombinedLogAdapter

java.lang.Object

com.dkfqs.tools.logging.CombinedLogAdapter

All Implemented Interfaces:

LogAdapterInterface

public class CombinedLogAdapter
extends java.lang.Object
implements LogAdapterInterface

A combined log adapter which supports logging to multiple log adapters, which can have different log levels.

Field Summary

Fields inherited from interface com.dkfqs.tools.logging.LogAdapterInterface

LOG_DEBUG, LOG_ERROR, LOG_FATAL, LOG_INFO, LOG_OFF, LOG_TRACE, LOG_WARN, logLevelSet

Constructor Summary

Constructors

Constructor and Description
CombinedLogAdapter()

Method Summary

Modifier and Type	Method and Description
void	addLogAdapter(LogAdapterInterface logAdapter) Add a log adapter.
void	clearLog() Clear the log: This method take no effect for some log adapters.
java.util.List<LogAdapterInterface>	getLogAdapters() Get the list of all added log adapters.
int	getLogLevel() Get the log level of the first log adapter.
void	init(java.lang.String[] args) Initialize the log adapter.
void	message(int logLevel, java.util.ArrayList<java.lang.String> messageList) Log a list of messages.
void	message(int logLevel, java.lang.String message) Log a message.
void	message(int logLevel, java.lang.String context, java.util.ArrayList<java.lang.String> messageList) Log a list of messages.
void	message(int logLevel, java.lang.String context, java.lang.String message) Log a message.
void	message(int logLevel, java.lang.String context, java.lang.String message, java.lang.Throwable throwable) Log a message with a stack trace.
void	message(int logLevel, java.lang.String message, java.lang.Throwable throwable) Log a message with a stack trace.
void	messageStacktrace(int logLevel, java.lang.String message) Log a message, and log the stacktrace of the current thread.
void	messageStacktrace(int logLevel, java.lang.String message, java.lang.Throwable throwable) Log a message with a stack trace, and log the stacktrace of the current thread.
void	setLogLevel(int currentLogLevel) Set a new log level for all log adapters.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.dkfqs.tools.logging.LogAdapterInterface

logLevelToString, stringToLogLevel, verifyLogLevel

Constructor Detail

CombinedLogAdapter

public CombinedLogAdapter()

Method Detail

addLogAdapter

public void addLogAdapter(LogAdapterInterface logAdapter)

Add a log adapter. Note that the log level of the log adapter must be configured before adding the log adapter.

Parameters:

logAdapter - the log adapter to add.

getLogAdapters

public java.util.List<LogAdapterInterface> getLogAdapters()

Get the list of all added log adapters. Note the returned list is a clone - but not the list entries.

Returns:

the list of all added log adapters

init

public void init(java.lang.String[] args)

Initialize the log adapter.

Specified by:

init in interface LogAdapterInterface

Parameters:

args - this log adapter does not support any initializing arguments, pass null or an empty array.

setLogLevel

public void setLogLevel(int currentLogLevel)

Set a new log level for all log adapters.

Specified by:

setLogLevel in interface LogAdapterInterface

Parameters:

currentLogLevel - the current log level to set

See Also:

LogAdapterInterface.LOG_DEBUG, LogAdapterInterface.LOG_TRACE, LogAdapterInterface.LOG_INFO, LogAdapterInterface.LOG_WARN, LogAdapterInterface.LOG_ERROR, LogAdapterInterface.LOG_FATAL, LogAdapterInterface.LOG_OFF

getLogLevel

public int getLogLevel()
                throws java.lang.RuntimeException

Get the log level of the first log adapter.

Specified by:

getLogLevel in interface LogAdapterInterface

Returns:

the log level of the first log adapter

Throws:

java.lang.RuntimeException - if no log adapters have added

See Also:

addLogAdapter(LogAdapterInterface)

message

public void message(int logLevel,
                    java.lang.String message)

Log a message. Use as context the current thread name.

Specified by:

message in interface LogAdapterInterface

Parameters:

logLevel - the log level of the message

message - the message

See Also:

LogAdapterInterface.LOG_DEBUG, LogAdapterInterface.LOG_TRACE, LogAdapterInterface.LOG_INFO, LogAdapterInterface.LOG_WARN, LogAdapterInterface.LOG_ERROR, LogAdapterInterface.LOG_FATAL, LogAdapterInterface.LOG_OFF

message

public void message(int logLevel,
                    java.util.ArrayList<java.lang.String> messageList)

Log a list of messages.

Specified by:

message in interface LogAdapterInterface

Parameters:

logLevel - the log level of the messages

messageList - the list of messages

See Also:

LogAdapterInterface.LOG_DEBUG, LogAdapterInterface.LOG_TRACE, LogAdapterInterface.LOG_INFO, LogAdapterInterface.LOG_WARN, LogAdapterInterface.LOG_ERROR, LogAdapterInterface.LOG_FATAL, LogAdapterInterface.LOG_OFF

message

public void message(int logLevel,
                    java.lang.String context,
                    java.lang.String message)

Log a message.

Specified by:

message in interface LogAdapterInterface

Parameters:

logLevel - the log level of the message

context - the context of the message, which is normally the current thread name

message - the message

See Also:

LogAdapterInterface.LOG_DEBUG, LogAdapterInterface.LOG_TRACE, LogAdapterInterface.LOG_INFO, LogAdapterInterface.LOG_WARN, LogAdapterInterface.LOG_ERROR, LogAdapterInterface.LOG_FATAL, LogAdapterInterface.LOG_OFF

message

public void message(int logLevel,
                    java.lang.String context,
                    java.util.ArrayList<java.lang.String> messageList)

Log a list of messages.

Specified by:

message in interface LogAdapterInterface

Parameters:

logLevel - the log level of the messages

context - the context of the message, which is normally the current thread name

messageList - the list of messages

See Also:

LogAdapterInterface.LOG_DEBUG, LogAdapterInterface.LOG_TRACE, LogAdapterInterface.LOG_INFO, LogAdapterInterface.LOG_WARN, LogAdapterInterface.LOG_ERROR, LogAdapterInterface.LOG_FATAL, LogAdapterInterface.LOG_OFF

message

public void message(int logLevel,
                    java.lang.String message,
                    java.lang.Throwable throwable)

Log a message with a stack trace. Use as context the current thread name.

Specified by:

message in interface LogAdapterInterface

Parameters:

logLevel - the log level of the message

message - the message

throwable - the throwable used to generate the stack trace information

See Also:

LogAdapterInterface.LOG_DEBUG, LogAdapterInterface.LOG_TRACE, LogAdapterInterface.LOG_INFO, LogAdapterInterface.LOG_WARN, LogAdapterInterface.LOG_ERROR, LogAdapterInterface.LOG_FATAL, LogAdapterInterface.LOG_OFF

message

public void message(int logLevel,
                    java.lang.String context,
                    java.lang.String message,
                    java.lang.Throwable throwable)

Log a message with a stack trace.

Specified by:

message in interface LogAdapterInterface

Parameters:

logLevel - the log level of the message

context - the context of the message, which is normally the current thread name

message - the message

throwable - the throwable used to generate the stack trace information

See Also:

LogAdapterInterface.LOG_DEBUG, LogAdapterInterface.LOG_TRACE, LogAdapterInterface.LOG_INFO, LogAdapterInterface.LOG_WARN, LogAdapterInterface.LOG_ERROR, LogAdapterInterface.LOG_FATAL, LogAdapterInterface.LOG_OFF

messageStacktrace

public void messageStacktrace(int logLevel,
                              java.lang.String message)

Log a message, and log the stacktrace of the current thread.

Specified by:

messageStacktrace in interface LogAdapterInterface

Parameters:

logLevel - logLevel the log level of the message

message - the message

See Also:

LogAdapterInterface.LOG_DEBUG, LogAdapterInterface.LOG_TRACE, LogAdapterInterface.LOG_INFO, LogAdapterInterface.LOG_WARN, LogAdapterInterface.LOG_ERROR, LogAdapterInterface.LOG_FATAL, LogAdapterInterface.LOG_OFF

messageStacktrace

public void messageStacktrace(int logLevel,
                              java.lang.String message,
                              java.lang.Throwable throwable)

Log a message with a stack trace, and log the stacktrace of the current thread.

Specified by:

messageStacktrace in interface LogAdapterInterface

Parameters:

logLevel - logLevel the log level of the message

message - the message

throwable - the throwable used to generate the stack trace information

See Also:

LogAdapterInterface.LOG_DEBUG, LogAdapterInterface.LOG_TRACE, LogAdapterInterface.LOG_INFO, LogAdapterInterface.LOG_WARN, LogAdapterInterface.LOG_ERROR, LogAdapterInterface.LOG_FATAL, LogAdapterInterface.LOG_OFF

clearLog

public void clearLog()
              throws java.io.IOException

Clear the log: This method take no effect for some log adapters.

Specified by:

clearLog in interface LogAdapterInterface

Throws:

java.io.IOException - if clearing of the log fails