com.dkfqs.tools.logging

Class CircularMemoryLogAdapter

java.lang.Object

com.dkfqs.tools.logging.CircularMemoryLogAdapter

All Implemented Interfaces:

LogAdapterInterface

public class CircularMemoryLogAdapter
extends java.lang.Object
implements LogAdapterInterface

A log adapter which write the log into a circular memory buffer. The default log level is LOG_INFO.

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
CircularMemoryLogAdapter(int maxMemoryLinesCapacity) Create a new instance.

Method Summary

Modifier and Type	Method and Description
void	clearLog() Clear the in-memory log.
java.util.ArrayList<java.lang.String>	getLog() Get the in-memory log.
int	getLogLevel() Get the log level.
int	getMaxMemoryLinesCapacity() Get the maximum capacity of the stored 'in memory lines'.
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 logLevel) Set the log level.
void	writeMessage(int logLevel, java.lang.String context, java.lang.String message) Basic method to write a log message.

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

CircularMemoryLogAdapter

public CircularMemoryLogAdapter(int maxMemoryLinesCapacity)

Create a new instance.

Parameters:

maxMemoryLinesCapacity - the maximum capacity of the stored 'in memory lines'

Method Detail

getMaxMemoryLinesCapacity

public int getMaxMemoryLinesCapacity()

Get the maximum capacity of the stored 'in memory lines'.

Returns:

the maximum capacity of the stored 'in memory lines'

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 logLevel)

Set the log level.

Specified by:

setLogLevel in interface LogAdapterInterface

Parameters:

logLevel - the 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()

Get the log level.

Specified by:

getLogLevel in interface LogAdapterInterface

Returns:

the log level

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)

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

writeMessage

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

Basic method to write a log message. Insert at the start of the message the current date and time, the current thread name and the log level.

Parameters:

logLevel - the log level of the message

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

message - the message

getLog

public java.util.ArrayList<java.lang.String> getLog()

Get the in-memory log.

Returns:

the in-memory log

clearLog

public void clearLog()

Clear the in-memory log.

Specified by:

clearLog in interface LogAdapterInterface