ej.util.message.basic

Class FilterMessageLogger

java.lang.Object

ej.util.message.basic.FilterMessageLogger

All Implemented Interfaces:

MessageLogger

public class FilterMessageLogger
extends Object
implements MessageLogger

A message logger delegates the messages build to a MessageBuilder and prints them to the standard output stream when the message level is higher that logger threshold.

See Also:

System.out

Field Summary

Fields

Modifier and Type	Field and Description
static char	ALL Print all message.
static FilterMessageLogger	INSTANCE An instance of FilterMessageLogger.
static char	OFF Print no messages.

Constructor Summary

Constructors

Constructor and Description
FilterMessageLogger() Creates an instance using BasicMessageBuilder.INSTANCE to build the messages.
FilterMessageLogger(MessageBuilder builder) Creates an instance passing the message builder used to build the messages.
FilterMessageLogger(MessageBuilder builder, char level) Creates an instance passing the message builder used to build the messages.

Method Summary

Modifier and Type	Method and Description
char	getLevel() Gets the level of the logger.
MessageBuilder	getMessageBuilder() Gets the message builder used to build the messages.
void	log(char level, String category, int id) Logs a message.
void	log(char level, String category, int id, Object... arguments) Logs a message with arguments.
void	log(char level, String category, int id, Throwable t) Logs a message with a throwable.
void	log(char level, String category, int id, Throwable t, Object... arguments) Logs a message with a throwable and arguments.
void	setLevel(char level) Sets the level of the logger.
void	setMessageBuilder(MessageBuilder builder) Sets the message builder used to build the messages.

Methods inherited from class java.lang.Object

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

Field Detail

ALL

public static final char ALL

Print all message.

See Also:

Constant Field Values

INSTANCE

public static final FilterMessageLogger INSTANCE

An instance of FilterMessageLogger.

OFF

public static final char OFF

Print no messages.

See Also:

Constant Field Values

Constructor Detail

FilterMessageLogger

public FilterMessageLogger()

Creates an instance using BasicMessageBuilder.INSTANCE to build the messages.

FilterMessageLogger

public FilterMessageLogger(MessageBuilder builder)

Creates an instance passing the message builder used to build the messages. Sets the print level to Level.INFO.

Parameters:

builder - the MessageBuilder to use, cannot be null.

Throws:

NullPointerException - if the given builder is null.

FilterMessageLogger

public FilterMessageLogger(MessageBuilder builder,
                           char level)

Creates an instance passing the message builder used to build the messages.

Parameters:

builder - the MessageBuilder to use, cannot be null.

level - the print level threshold.

Throws:

NullPointerException - if the given builder is null.

Method Detail

getLevel

public char getLevel()

Gets the level of the logger. The level will be:

• OFF
• ALL
• Any Level

Returns:

the logger level.

getMessageBuilder

public MessageBuilder getMessageBuilder()

Description copied from interface: MessageLogger

Gets the message builder used to build the messages.

Specified by:

getMessageBuilder in interface MessageLogger

Returns:

the message builder.

log

public void log(char level,
                String category,
                int id)

Description copied from interface: MessageLogger

Logs a message.

Specified by:

log in interface MessageLogger

Parameters:

level - the level of the message.

category - the category of the message.

id - the ID of the message.

See Also:

MessageBuilder.buildMessage(char, String, int)

log

public void log(char level,
                String category,
                int id,
                Object... arguments)

Description copied from interface: MessageLogger

Logs a message with arguments.

Specified by:

log in interface MessageLogger

Parameters:

level - the level of the message.

category - the category of the message.

id - the ID of the message.

arguments - the arguments.

See Also:

MessageBuilder.buildMessage(char, String, int, Object...)

log

public void log(char level,
                String category,
                int id,
                Throwable t)

Description copied from interface: MessageLogger

Logs a message with a throwable.

Specified by:

log in interface MessageLogger

Parameters:

level - the level of the message.

category - the category of the message.

id - the ID of the message.

t - the throwable.

See Also:

MessageBuilder.buildMessage(char, String, int, Throwable)

log

public void log(char level,
                String category,
                int id,
                Throwable t,
                Object... arguments)

Description copied from interface: MessageLogger

Logs a message with a throwable and arguments.

Specified by:

log in interface MessageLogger

Parameters:

level - the level of the message.

category - the category of the message.

id - the ID of the message.

t - the throwable.

arguments - the arguments.

See Also:

MessageBuilder.buildMessage(char, String, int, Throwable, Object...)

setLevel

public void setLevel(char level)
              throws IllegalArgumentException

Sets the level of the logger. The level should be:

• OFF.
• ALL.
• Any Level.

Parameters:

level - the level to use.

Throws:

IllegalArgumentException - if the given level is not valid.

setMessageBuilder

public void setMessageBuilder(MessageBuilder builder)

Description copied from interface: MessageLogger

Sets the message builder used to build the messages.

Specified by:

setMessageBuilder in interface MessageLogger

Parameters:

builder - the message builder to set, cannot be null.