org.usefultoys.slf4j.meter

Class MeterFactory

java.lang.Object

org.usefultoys.slf4j.meter.MeterFactory

public final class MeterFactory
extends Object

The MeterFactory is a utility class producing Meters. The methods are shortcuts for calling the Meter constructor.

Author:

Daniel Felix Ferber

Method Summary

Modifier and Type	Method and Description
static Meter	getCurrentMeter() Returns the most recently started Meter on the current thread.
static Meter	getCurrentSubMeter(String suboperationName) Creates a new Meter whose name is subordinated under the hierarchy last started meter onthe current thread.
static Meter	getMeter(Class<?> clazz) Returns a Meter with given category equal to the class name, which will also be the logger name.
static Meter	getMeter(Class<?> clazz, String operationName) Returns a Meter with given category equal to the class name, which will also be the logger name.
static Meter	getMeter(org.slf4j.Logger logger) Returns a Meter with category equal to the logger name and as meter category.
static Meter	getMeter(org.slf4j.Logger logger, String operationName) Returns a Meter with given category equal to the logger name.
static Meter	getMeter(String category) Returns a Meter with given category, which will also be also the logger name.

Methods inherited from class java.lang.Object

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

Method Detail

getMeter

public static Meter getMeter(org.slf4j.Logger logger)

Returns a Meter with category equal to the logger name and as meter category.

Parameters:

logger - The logger used to report messages.

Returns:

the Meter

getMeter

public static Meter getMeter(String category)

Returns a Meter with given category, which will also be also the logger name.

Parameters:

category - The Meter category and logger name.

Returns:

the Meter

getMeter

public static Meter getMeter(Class<?> clazz)

Returns a Meter with given category equal to the class name, which will also be the logger name.

Parameters:

clazz - The class which name is used as category and logger name.

Returns:

the Meter

getMeter

public static Meter getMeter(Class<?> clazz,
                             String operationName)

Returns a Meter with given category equal to the class name, which will also be the logger name.

Parameters:

clazz - The class which name is used as category and logger name.

operationName - Additional identification to distinguish operations reported on the same logger.

Returns:

the Meter

getMeter

public static Meter getMeter(org.slf4j.Logger logger,
                             String operationName)

Returns a Meter with given category equal to the logger name.

Parameters:

logger - The logger used to report messages and as meter category.

operationName - Additional identification to distinguish operations reported on the same logger.

Returns:

the Meter

getCurrentMeter

public static Meter getCurrentMeter()

Returns the most recently started Meter on the current thread.

Returns:

the Meter

getCurrentSubMeter

public static Meter getCurrentSubMeter(String suboperationName)

Creates a new Meter whose name is subordinated under the hierarchy last started meter onthe current thread. Useful if a large task may be subdivided into smaller task and reported individually. The new meter uses the category of this meter. The new meter uses a name of the this meter, appended by slash and its own name.

Parameters:

suboperationName - Additional identification appended to the subordinated meter name.

Returns:

the Meter