com.dkfqs.tools.logging

Interface LogAdapterInterface

All Known Implementing Classes:

CircularMemoryLogAdapter, CombinedLogAdapter, MemoryLogAdapter, NullLogAdapter, StdoutLogAdapter

public interface LogAdapterInterface

The log adapter interface.

Field Summary

Fields

Modifier and Type	Field and Description
static int	LOG_DEBUG Debug log level.
static int	LOG_ERROR Error log level.
static int	LOG_FATAL Fatal log level - System.exit(1) may be called later.
static int	LOG_INFO Info log level.
static int	LOG_OFF Logging is disabled.
static int	LOG_TRACE Trace log level.
static int	LOG_WARN Waring log level.
static java.util.HashSet<java.lang.Integer>	logLevelSet A HashSet of all valid log levels.

Method Summary

Modifier and Type	Method and Description
void	clearLog() Clear the log.
int	getLogLevel() Get the log level.
void	init(java.lang.String[] args) Initialize the log adapter.
static java.lang.String	logLevelToString(int logLevel) Convert a log level into a string.
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 logLevel) Set the log level.
static int	stringToLogLevel(java.lang.String s) Converts a string to a log level.
static void	verifyLogLevel(int logLevel) Verify the value of a log level.

Field Detail

LOG_DEBUG

static final int LOG_DEBUG

Debug log level.

See Also:

Constant Field Values

LOG_TRACE

static final int LOG_TRACE

Trace log level.

See Also:

Constant Field Values

LOG_INFO

static final int LOG_INFO

Info log level.

See Also:

Constant Field Values

LOG_WARN

static final int LOG_WARN

Waring log level.

See Also:

Constant Field Values

LOG_ERROR

static final int LOG_ERROR

Error log level.

See Also:

Constant Field Values

LOG_FATAL

static final int LOG_FATAL

Fatal log level - System.exit(1) may be called later.

See Also:

Constant Field Values

LOG_OFF

static final int LOG_OFF

Logging is disabled.

See Also:

Constant Field Values

logLevelSet

static final java.util.HashSet<java.lang.Integer> logLevelSet

A HashSet of all valid log levels.

Method Detail

verifyLogLevel

static void verifyLogLevel(int logLevel)

Verify the value of a log level.

Parameters:

logLevel - the log level to verify.

Throws:

java.lang.IllegalArgumentException - if the value of the log level is invalid

See Also:

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

logLevelToString

static java.lang.String logLevelToString(int logLevel)

Convert a log level into a string.

Parameters:

logLevel - the log level

Returns:

the log level

See Also:

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

stringToLogLevel

static int stringToLogLevel(java.lang.String s)

Converts a string to a log level.

Parameters:

s - the following values are supported: debug, info, warn, error, fatal and off.

Returns:

the log level

Throws:

java.lang.IllegalArgumentException - in the input string contains an unsupported value

See Also:

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

init

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

Initialize the log adapter.

Parameters:

args - the initial arguments of the log adapter.

setLogLevel

void setLogLevel(int logLevel)

Set the log level.

Parameters:

logLevel - the log level to set

See Also:

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

getLogLevel

int getLogLevel()

Get the log level.

Returns:

the log level

See Also:

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

message

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

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

Parameters:

logLevel - the log level of the message

message - the message

See Also:

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

message

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

Log a list of messages.

Parameters:

logLevel - the log level of the messages

messageList - the list of messages

See Also:

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

message

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

Log a message.

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:

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

message

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

Log a list of messages.

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:

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

message

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.

Parameters:

logLevel - the log level of the message

message - the message

throwable - the throwable used to generate the stack trace information

See Also:

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

message

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

Log a message with a stack trace

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:

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

messageStacktrace

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

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

Parameters:

logLevel - logLevel the log level of the message

message - the message

See Also:

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

messageStacktrace

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.

Parameters:

logLevel - logLevel the log level of the message

message - the message

throwable - the throwable used to generate the stack trace information

See Also:

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

clearLog

void clearLog()
       throws java.io.IOException

Clear the log. Depending on the implementation of the log adapter this method may take no effect.

Throws:

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