net.sf.aspect4log

Annotation Type Log

@Retention(value=RUNTIME)
@Target(value={TYPE,METHOD,CONSTRUCTOR})
public @interface Log

This annotation defines logging rules on method, constructor or on the entire class. Annotation placed on constructor/method overrides all values of annotation placed on class.

Author:

Vitaliy S

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	argumentsTemplate specifies template for logging arguments by default it is ${args} which means all arguments are logged.
Log.Level	enterLevel
Log.Level	exitLevel WARNING: making exitLevel smaller than enterLevel can make the log hard to read.
boolean	indent
String	mdcKey
String	mdcTemplate
Log.Exceptions[]	on
String	resultTemplate

Element Detail

enterLevel

public abstract Log.Level enterLevel

Returns:

Log.Level to use on method enter

Default:

net.sf.aspect4log.Log.Level.DEBUG

exitLevel

public abstract Log.Level exitLevel

WARNING: making exitLevel smaller than enterLevel can make the log hard to read.

Returns:

Log.Level to use on successful method exit.

Default:

net.sf.aspect4log.Log.Level.DEBUG

on

public abstract Log.Exceptions[] on

Returns:

an array of Log.Exceptions that defines how exit on different exceptions is logged. For each exception it is possible to specify by default all runtime exceptions print a stack trace, all checked exception do not print a stack trace.

Default:

{@net.sf.aspect4log.Log.Exceptions(level=net.sf.aspect4log.Log.Level.ERROR, exceptions=java.lang.RuntimeException.class, stackTrace=true), @net.sf.aspect4log.Log.Exceptions(level=net.sf.aspect4log.Log.Level.WARN, exceptions=java.lang.Exception.class, stackTrace=false)}

argumentsTemplate

public abstract String argumentsTemplate

specifies template for logging arguments by default it is ${args} which means all arguments are logged. you can write it yourself by referencing to arguments by index. E.g ${args[0]},${args[1]} etc..

Returns:

arguments template

Default:

"${args}"

resultTemplate

public abstract String resultTemplate

Returns:

A pattern representing value returned from the method. The default value it is $result.

Default:

"${result}"

indent

public abstract boolean indent

Returns:

true if indent is needed, returns false otherwise. NOTE: You may consider not to use indent in case the method level in stack trace will be too high, or in case you log recursive method.

Default:

true

mdcKey

public abstract String mdcKey

Returns:

if specified will be set as MDC key. NOTE: The typical use case for mdc key is identification method (e.g. in a filter). The typical key will be user's login.

Default:

""

mdcTemplate

public abstract String mdcTemplate

Returns:

An mdc patter. Can be any expression using $args bean

Default:

""