org.loginject

Class LogParameter<_Type_>

java.lang.Object

org.loginject.LogParameter<_Type_>

Type Parameters:

_Type_ - the parameter type (must match the parameter type in the factory method)

public class LogParameter<_Type_>
extends Object

A LogParameter encapsulates a parameter that is passed to a logger factory method at the of injection. It does not necessarily represent a constant value but may vary according to the injection point. For example, currentClass() and currentClassName() refer to the Class object and class name at the injection point, not to class that creates the LogParameter.

Author:

Mirko Raner

Method Summary

Modifier and Type	Method and Description
static LogParameter<String>	constantString(String string) Returns a LogParameter representing a constant string (always the same string, independent of injection point).
static LogParameter<Class<?>>	currentClass()
static LogParameter<String>	currentClassName()
Class<_Type_>	getParameterType()
_Type_	getValue(Class<?> currentClass) Determines the parameter's value for the current injection point.
static <_Parameter_> LogParameter<_Parameter_>	parameter(_Parameter_ parameter) Returns a LogParameter representing a constant value (always the same value, independent of injection point).

Methods inherited from class java.lang.Object

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

Method Detail

currentClass

public static LogParameter<Class<?>> currentClass()

Returns:

a LogParameter representing the Class into which the logger is injected.

currentClassName

public static LogParameter<String> currentClassName()

Returns:

a LogParameter representing the name of the Class into which the logger is injected.

constantString

public static LogParameter<String> constantString(String string)

Returns a LogParameter representing a constant string (always the same string, independent of injection point).

Parameters:

string - the constant string

Returns:

the LogParameter

parameter

public static <_Parameter_> LogParameter<_Parameter_> parameter(_Parameter_ parameter)

Returns a LogParameter representing a constant value (always the same value, independent of injection point).

Type Parameters:

_Parameter_ - the log parameter type

Parameters:

parameter - the value

Returns:

the LogParameter

getParameterType

public Class<_Type_> getParameterType()

Returns:

the parameter's type

getValue

public _Type_ getValue(Class<?> currentClass)

Determines the parameter's value for the current injection point.

Parameters:

currentClass - the class into which the logger is injected

Returns:

the parameter value