com.xdev.jadoth.util.logging.jul

Class LoggingAspect

java.lang.Object

com.xdev.jadoth.util.logging.jul.LoggingAspect

public class LoggingAspect
extends Object

Simple Wrapper around java.util.logging.Logger with little logic of its own, just to reduce the amount of code that needs to be written for logging (by ~50%).
This is achieved by assigning a default level to a logger that can be used for every message.

• This way, it can be saved to refactor the Level (or method name respectively) in every occurance of log().
• In addition, checks like logger.isLoggable(LoggingLevels.CATEGORY_MYLEVEL) can be reduced to logger.isLoggable()
• Also, a log(etc, Object... parameters) method is provided to further save boiler plate code like new Object[]{...

Examples:
logger.log(Level.FINEST, "Detailed message");
|
V
logger.log("Detailed message");



if(logger.isLoggable(LoggingLevels.CATEGORY_MYLEVEL)) logger.log(LoggingLevels.CATEGORY_MYLEVEL, "Detailed message");
|
V
if(logger.isLoggable()) logger.log("Detailed message");



logger.log(Level.FINEST, "Detailed message: {0}, {1}, {2}", new Object[]{a,b,c});
|
V
logger.log("Detailed message: {0}, {1}, {2}", a,b,c);


The name was chosen for lack of significant synonyms for classes dealing generally with logging ("Logger", "Logging", etc.) and in inspiration by Aspect Orientation (and maybe future use of this class in such a way. See interface LoggingContext)

Author:

Thomas Muenz

Constructor Summary

Constructors

Constructor and Description
LoggingAspect(Logger logger, Level defaultLevel) Instantiates a new logging aspect.
LoggingAspect(Logger logger, Level defaultLevel, Class<?> caller) Instantiates a new logging aspect.

Method Summary

Modifier and Type	Method and Description
boolean	checkLevel() Check level.
boolean	checkLevel(Level level) Check level.
String	determineSourceClassName() Determine source class name.
protected String	determineSourceMethodName() Determine source method name.
Level	getDefaultLevel() Gets the default level.
Logger	getLogger() Gets the logger.
String	getSourceClassName() Gets the source class name.
boolean	isEnabled() Checks if is enabled.
boolean	isLoggable() Checks if is loggable.
boolean	isLoggable(Level level) Checks if is loggable.
void	log(Level level, String message, Object... parameters) Log.
void	log(Level level, String message, Throwable thrown) Log.
void	log(Level level, Throwable thrown) Log.
static void	log(LoggingContext context, CharSequence message) Log.
static void	log(LoggingContext context, String method, CharSequence message) This is the best effort with object oriented techniques to abstract the logging aspect.
void	log(LogRecord record) Log.
void	log(String message, Object... parameters) Log.
void	log(String message, Throwable thrown) Log.
void	logA(Level level, String message, Object... parameters) Log a.
void	logA(Level level, String message, Throwable thrown) Log a.
void	logA(String message, Object... parameters) Log a.
void	logA(String message, Throwable thrown) Log a.
void	logB(Level level, String message, Class<?> sourceClass, String methodName, Object... parameters) Log b.
void	logB(Level level, String message, Class<?> sourceClass, String methodName, Throwable thrown) Log b.
void	logC(Level level, String message, Class<?> sourceClass, Object... parameters) Log c.
void	logC(Level level, String message, Class<?> sourceClass, Throwable thrown) Log c.
void	logC(String message, Class<?> sourceClass, Object... parameters) Log c.
void	logC(String message, Class<?> sourceClass, Throwable thrown) Log c.
void	logM(Level level, String message, String methodName, Object... parameters) Log m.
void	logM(Level level, String message, String methodName, Throwable thrown) Log m.
void	logM(String message, String methodName, Object... parameters) Log m.
void	logM(String message, String methodName, Throwable thrown) Log m.
void	setDefaultLevel(Level defaultLevel)
void	setLogger(Logger logger)
void	setSourceClassName(String sourceClassName) Sets the source class name.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoggingAspect

public LoggingAspect(Logger logger,
                     Level defaultLevel)

Instantiates a new logging aspect.

Parameters:

logger - the logger to which defaultLevel will be associated. My not be null.

defaultLevel - the default level for logger. My not be null.

LoggingAspect

public LoggingAspect(Logger logger,
                     Level defaultLevel,
                     Class<?> caller)

Instantiates a new logging aspect.

Parameters:

logger - the logger to which defaultLevel will be associated.

defaultLevel - the default level for logger. My not be null.

caller - the caller

Method Detail

log

public static void log(LoggingContext context,
                       String method,
                       CharSequence message)

This is the best effort with object oriented techniques to abstract the logging aspect.

Parameters:

context - the context

method - the method

message - the message

log

public static void log(LoggingContext context,
                       CharSequence message)

Log.

Parameters:

context - the context

message - the message

getLogger

public Logger getLogger()

Gets the logger.

Returns:

the logger

getDefaultLevel

public Level getDefaultLevel()

Gets the default level.

Returns:

the defaultLevel

getSourceClassName

public String getSourceClassName()

Gets the source class name.

Returns:

the sourceClassName

setSourceClassName

public void setSourceClassName(String sourceClassName)

Sets the source class name.

Parameters:

sourceClassName - the sourceClassName to set

setLogger

public void setLogger(Logger logger)

Parameters:

logger - the logger to set

setDefaultLevel

public void setDefaultLevel(Level defaultLevel)

Parameters:

defaultLevel - the defaultLevel to set

isEnabled

public boolean isEnabled()

Checks if is enabled.

Returns:

true, if is enabled

isLoggable

public boolean isLoggable()

Checks if is loggable.

Returns:

true, if is loggable

isLoggable

public boolean isLoggable(Level level)

Checks if is loggable.

Parameters:

level - the level

Returns:

true, if is loggable

checkLevel

public boolean checkLevel()

Check level.

Returns:

true, if successful

checkLevel

public boolean checkLevel(Level level)

Check level.

Parameters:

level - the level

Returns:

true, if successful

log

public void log(LogRecord record)

Log.

Parameters:

record - the record

log

public void log(String message,
                Object... parameters)

Log.

Parameters:

message - the message

parameters - the parameters

log

public void log(String message,
                Throwable thrown)

Log.

Parameters:

message - the message

thrown - the thrown

log

public void log(Level level,
                String message,
                Object... parameters)

Log.

Parameters:

level - the level

message - the message

parameters - the parameters

log

public void log(Level level,
                String message,
                Throwable thrown)

Log.

Parameters:

level - the level

message - the message

thrown - the thrown

log

public void log(Level level,
                Throwable thrown)

Log.

Parameters:

level - the level

thrown - the thrown

logA

public void logA(String message,
                 Object... parameters)

Log a.

Parameters:

message - the message

parameters - the parameters

logA

public void logA(String message,
                 Throwable thrown)

Log a.

Parameters:

message - the message

thrown - the thrown

logA

public void logA(Level level,
                 String message,
                 Object... parameters)

Log a.

Parameters:

level - the level

message - the message

parameters - the parameters

logA

public void logA(Level level,
                 String message,
                 Throwable thrown)

Log a.

Parameters:

level - the level

message - the message

thrown - the thrown

logM

public void logM(String message,
                 String methodName,
                 Object... parameters)

Log m.

Parameters:

message - the message

methodName - the method name

parameters - the parameters

logM

public void logM(String message,
                 String methodName,
                 Throwable thrown)

Log m.

Parameters:

message - the message

methodName - the method name

thrown - the thrown

logM

public void logM(Level level,
                 String message,
                 String methodName,
                 Object... parameters)

Log m.

Parameters:

level - the level

message - the message

methodName - the method name

parameters - the parameters

logM

public void logM(Level level,
                 String message,
                 String methodName,
                 Throwable thrown)

Log m.

Parameters:

level - the level

message - the message

methodName - the method name

thrown - the thrown

logC

public void logC(String message,
                 Class<?> sourceClass,
                 Object... parameters)

Log c.

Parameters:

message - the message

sourceClass - the source class

parameters - the parameters

logC

public void logC(String message,
                 Class<?> sourceClass,
                 Throwable thrown)

Log c.

Parameters:

message - the message

sourceClass - the source class

thrown - the thrown

logC

public void logC(Level level,
                 String message,
                 Class<?> sourceClass,
                 Object... parameters)

Log c.

Parameters:

level - the level

message - the message

sourceClass - the source class

parameters - the parameters

logC

public void logC(Level level,
                 String message,
                 Class<?> sourceClass,
                 Throwable thrown)

Log c.

Parameters:

level - the level

message - the message

sourceClass - the source class

thrown - the thrown

logB

public void logB(Level level,
                 String message,
                 Class<?> sourceClass,
                 String methodName,
                 Object... parameters)

Log b.

Parameters:

level - the level

message - the message

sourceClass - the source class

methodName - the method name

parameters - the parameters

logB

public void logB(Level level,
                 String message,
                 Class<?> sourceClass,
                 String methodName,
                 Throwable thrown)

Log b.

Parameters:

level - the level

message - the message

sourceClass - the source class

methodName - the method name

thrown - the thrown

determineSourceMethodName

protected String determineSourceMethodName()

Determine source method name.

Returns:

the string

determineSourceClassName

public String determineSourceClassName()

Determine source class name.

Returns:

the string