Class EngineLoggingFactory

java.lang.Object

com.blackrook.engine.EngineLoggingFactory

public class EngineLoggingFactory
extends Object

Some kind of logger for logging messages.

Author:

Matthew Tropiano

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EngineLoggingFactory.ConsoleLogger	A logger driver that outputs to Standard Out.
static interface	EngineLoggingFactory.Driver	A logging output driver that outputs messages to a log when it receives a set of inputs.
static class	EngineLoggingFactory.FileLogger	A logging driver that writes to a text file.
static interface	EngineLoggingFactory.Logger	Logger interface for all log writing.
static enum	EngineLoggingFactory.LogLevel	Logging levels.
static class	EngineLoggingFactory.PrintStreamLogger	A standard logger for outputting to a print stream.

Constructor Summary

Constructors

Constructor	Description
EngineLoggingFactory(EngineLoggingFactory.Driver... drivers)	Creates a new logging factory.
EngineLoggingFactory(EngineLoggingFactory.LogLevel level, EngineLoggingFactory.Driver... drivers)	Creates a new logging factory.

Method Summary

Modifier and Type	Method	Description
void	addDriver(EngineLoggingFactory.Driver... drivers)	Adds a logging driver or drivers from this factory.
static EngineLoggingFactory.Logger	createConsoleLoggerFor(Class<?> clazz)	A convenience method for creating a Console-appending logger for a particular source by class name.
static EngineLoggingFactory.Logger	createConsoleLoggerFor(Class<?> clazz, boolean fullyQualified)	A convenience method for creating a Console-appending logger for a particular source by class name.
static EngineLoggingFactory.Logger	createConsoleLoggerFor(String name)	A convenience method for creating a Console-appending logger for a particular source by name.
static EngineLoggingFactory	createConsoleLoggingFactory()	A convenience method for creating a Console-appending logger factory.
EngineLoggingFactory.Logger	getLogger(Class<?> clz)	Creates a new Logger for outputting logs, using the name of the class as a source name.
EngineLoggingFactory.Logger	getLogger(Class<?> clz, boolean fullyQualified)	Creates a new Logger for outputting logs, using the name of the class as a source name.
EngineLoggingFactory.Logger	getLogger(String name)	Creates a new Logger for outputting logs.
EngineLoggingFactory.LogLevel	getLoggingLevel()	Returns the current logging level.
void	removeDriver(EngineLoggingFactory.Driver... drivers)	Removes a logging driver or drivers from this factory.
void	setLoggingLevel(EngineLoggingFactory.LogLevel level)	Returns the current logging level.

Methods inherited from class Object

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

Constructor Details

EngineLoggingFactory

public EngineLoggingFactory(EngineLoggingFactory.Driver... drivers)

Creates a new logging factory. The starting logging level is EngineLoggingFactory.LogLevel.DEBUG.

Parameters:

drivers - the logging driver to use for directing output.

EngineLoggingFactory

public EngineLoggingFactory(EngineLoggingFactory.LogLevel level,
 EngineLoggingFactory.Driver... drivers)

Creates a new logging factory.

Parameters:

level - the starting logging level.

drivers - the logging driver to use for directing output.

Method Details

createConsoleLoggingFactory

public static EngineLoggingFactory createConsoleLoggingFactory()

A convenience method for creating a Console-appending logger factory.

Equivalent to: new LoggingFactory(LogLevel.DEBUG, new ConsoleLogger())

Returns:

the new logging factory.

createConsoleLoggerFor

public static EngineLoggingFactory.Logger createConsoleLoggerFor(String name)

A convenience method for creating a Console-appending logger for a particular source by name.

Equivalent to: createConsoleLoggingFactory().getLogger(name)

It may be better, thread-resource-wise to create a single factory if you are logging multiple sources/classes through it.

Parameters:

name - the source name of this logger.

Returns:

the new logger.

See Also:

• getLogger(String)

createConsoleLoggerFor

public static EngineLoggingFactory.Logger createConsoleLoggerFor(Class<?> clazz)

A convenience method for creating a Console-appending logger for a particular source by class name.

Equivalent to: createConsoleLoggingFactory().getLogger(clazz)

It may be better, thread-resource-wise to create a single factory if you are logging multiple sources/classes through it.

Parameters:

clazz - the class to create the logger for.

Returns:

the new logger.

See Also:

• getLogger(Class)

createConsoleLoggerFor

public static EngineLoggingFactory.Logger createConsoleLoggerFor(Class<?> clazz,
 boolean fullyQualified)

A convenience method for creating a Console-appending logger for a particular source by class name.

Equivalent to: createConsoleLoggingFactory().getLogger(clazz, fullyQualified)

It may be better, thread-resource-wise to create a single factory if you are logging multiple sources/classes through it.

Parameters:

clazz - the class to create the logger for.

fullyQualified - if true, the output name is a fully-qualified name.

Returns:

the new logger.

See Also:

• getLogger(Class, boolean)

addDriver

public void addDriver(EngineLoggingFactory.Driver... drivers)

Adds a logging driver or drivers from this factory.

Parameters:

drivers - the drivers to add.

removeDriver

public void removeDriver(EngineLoggingFactory.Driver... drivers)

Removes a logging driver or drivers from this factory.

Parameters:

drivers - the drivers to remove.

getLoggingLevel

public EngineLoggingFactory.LogLevel getLoggingLevel()

Returns the current logging level. Anything logged using EngineLoggingFactory.Loggers generated by this factory is tested against the current logging level. If the logging level of the message is less than or equal to the current logging level, it is logged.

Returns:

the current logging level.

setLoggingLevel

public void setLoggingLevel(EngineLoggingFactory.LogLevel level)

Returns the current logging level. Anything logged using EngineLoggingFactory.Loggers generated by this factory is tested against the current logging level. If the logging level of the message is less than or equal to the current logging level, it is logged.

Parameters:

level - the new logging level.

getLogger

public EngineLoggingFactory.Logger getLogger(String name)

Creates a new Logger for outputting logs. This logger uses the logging level and driver defined on this logging factory.

Parameters:

name - the source name.

Returns:

a logger to call to output logging to.

getLogger

public EngineLoggingFactory.Logger getLogger(Class<?> clz)

Creates a new Logger for outputting logs, using the name of the class as a source name. This logger uses the logging level and driver defined on this logging factory.

Parameters:

clz - the class to use.

Returns:

a logger to call to output logging to.

getLogger

public EngineLoggingFactory.Logger getLogger(Class<?> clz,
 boolean fullyQualified)

Creates a new Logger for outputting logs, using the name of the class as a source name. This logger uses the logging level and driver defined on this logging factory.

Parameters:

clz - the class to use.

fullyQualified - if true, use the fully-qualified name.

Returns:

a logger to call to output logging to.