com.toolsverse.util.log

Interface LogWriter

All Known Implementing Classes:

Log4jWriter

public interface LogWriter

LogWriter is an interface which each particular log writer class must implement.

Since:

1.0

Version:

2.0

See Also:

Log4jWriter

Method Summary

Modifier and Type	Method and Description
void	addAppender(Object appender) Adds the appender.
void	addAppender(Object object, Object appender) Adds the appender.
Object	getDefaultAppender(OutputStream stream) Creates the default appender which outputs to the stream.
String	log(int logType, Object object, String message, Throwable throwable) Logs a message.
void	removeAppender(Object appender) Removes the appender.
void	removeAppender(Object object, Object appender) Removes the appender.
void	setLevel(int level) Sets the log levelt.
void	setLevel(Object object, int level) Sets the log level for the object.

Method Detail

addAppender

void addAppender(Object appender)

Adds the appender.

Parameters:

appender - the appender

addAppender

void addAppender(Object object,
                 Object appender)

Adds the appender.

Parameters:

object - the object

appender - the appender

getDefaultAppender

Object getDefaultAppender(OutputStream stream)

Creates the default appender which outputs to the stream.

Parameters:

stream - the stream

Returns:

the default appender

log

String log(int logType,
           Object object,
           String message,
           Throwable throwable)

Logs a message.

Parameters:

logType - The type of log that is being written. Common types are "info", "debug", "warning", "fatal", etc.

object - The object that is writing the message. If the object is a static class (such as Logger), pass the Class object instead - e.g., "Logger.class". Null is acceptable.

message - The actual message to write to the log. Null is acceptable, but why would you?

throwable - Any Throwable whose contents you want written with the log message. The Throwable's cause is check recursively and displays all causes in an abbreviated format.

Returns:

The exact message that was written to the log. This is a concatenation of the current time, the log type, the name of the object that is writing to the log, the method name from which the log was written, the message, and if applicable, the throwable (and any nested throwables) and their stack traces.

removeAppender

void removeAppender(Object appender)

Removes the appender.

Parameters:

appender - the appender

removeAppender

void removeAppender(Object object,
                    Object appender)

Removes the appender.

Parameters:

object - the object

appender - the appender

setLevel

void setLevel(int level)

Sets the log levelt.

Parameters:

level - The type of log that is being written. Common types are "info", "debug", "warning", "fatal", etc.

setLevel

void setLevel(Object object,
              int level)

Sets the log level for the object.

Parameters:

object - The object that is writing the message.

level - The type of log that is being written. Common types are "info", "debug", "warning", "fatal", etc.