LoggerImpl (SeMoA API Documentation)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

de.fhg.igd.logging
Class LoggerImpl

java.lang.Object
  de.fhg.igd.logging.LoggerImpl

All Implemented Interfaces:: Logger

public final class LoggerImpl
extends Object
implements Logger

This is a generic Logger implementation which provides the defined functionality by means of a Wrapper which depends on the underlying logging system. Instances are being used as targets of LoggerProxy objects.

Version:: "$Id: LoggerImpl.java 1913 2007-08-08 02:41:53Z jpeters $"
Author:: Matthias Pressfreund

Field Summary
`private static Set`	`cache_` The storage for all deployed logger objects
`private int`	`cnt_` The reference counter
`private String`	`fgn_` The formatted group name, ready for printout
`protected String`	`group_` The logger group
`protected Wrapper`	`wrapper_` The target wrapper

Constructor Summary
`private`	`LoggerImpl(String name, String group, Class wclazz)` Hidden construction.

Method Summary
`void`	`caught(LogLevel level, String msg, Throwable thrown)` This method implicitely calls `log(de.fhg.igd.logging.LogLevel, java.lang.String)` first, then `caught(Throwable)`.
`void`	`caught(Throwable thrown)` This method is supposed to be used for logging the catching of a `Throwable` (and subclasses).
`void`	`debug(String msg)` Creates a log entry on `LogLevel.DEBUG`.
`void`	`dismiss()` Removes this `LoggerImpl` from the cache in case it is no longer referenced.
`void`	`entering()` This method is supposed to be used for logging the entry of a parameterless method.
`void`	`entering(Object[] params)` This method is supposed to be used for logging the entry of a method with a set of parameters.
`boolean`	`equals(Object obj)`
`void`	`error(String msg)` Creates a log entry on `LogLevel.ERROR`.
`void`	`exiting()` This method is supposed to be used for logging the exit of a method without return value.
`void`	`exiting(Object result)` This method is supposed to be used for logging the exit of a method with a return value.
`void`	`fatal(String msg)` Creates a log entry on `LogLevel.FATAL`.
`private String`	`formatCaught(Throwable thrown)` Create a generic message for a caught `Throwable`.
`private String`	`formatGenericMessage(StringBuffer buf)` Create a generic message using the group name and the current `SourceLocation`.
`private String`	`formatMethodEntry(Object[] params)` Create a generic message for a method entry event.
`private String`	`formatMethodExit(Object result)` Create a generic message for a method exit event.
`private StringBuffer`	`formatStackTrace(Throwable thrown)` Create a printout for a `Throwable`.
`private String`	`formatThrowing(Throwable thrown)` Create a generic message for a `Throwable` that will cause a method exit.
`String`	`getGroup()`
`Wrapper`	`getWrapper()`
`int`	`hashCode()`
`void`	`info(String msg)` Creates a log entry on `LogLevel.INFO`.
`boolean`	`isEnabled(LogLevel level)` Find out if logging would be performed at the given log level.
`void`	`log(LogLevel level, String msg)` This is the generic log method to be used for creating a log entry on the specified log level.
`(package private) static LoggerImpl`	`requestFor(String name, String group, Class wclazz)` Request a `LoggerImpl` instance.
`void`	`severe(String msg)` Creates a log entry on `LogLevel.SEVERE`.
`void`	`throwing(LogLevel level, String msg, Throwable thrown)` This method implicitely calls `log(de.fhg.igd.logging.LogLevel, java.lang.String)` first, then `throwing(Throwable)`.
`void`	`throwing(Throwable thrown)` This method is supposed to be used for logging the creation and method exit by a `Throwable` (and subclasses).
`String`	`toString()`
`void`	`trace(String msg)` Creates a log entry on `LogLevel.TRACE`.
`void`	`warning(String msg)` Creates a log entry on `LogLevel.WARNING`.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

cache_

private static Set cache_

The storage for all deployed logger objects

cnt_

private int cnt_

The reference counter

group_

protected String group_

The logger group

fgn_

private String fgn_

The formatted group name, ready for printout

wrapper_

protected Wrapper wrapper_

The target wrapper

Constructor Detail

LoggerImpl

private LoggerImpl(String name,
                   String group,
                   Class wclazz)

Hidden construction.
Parameters:: name - The logger name; group - The logger group; wclazz - The Wrapper implementation class to be used

Method Detail

requestFor

static LoggerImpl requestFor(String name,
                             String group,
                             Class wclazz)

Request a LoggerImpl instance.

Parameters:: wclazz - The Wrapper implementation class to be used; name - The logger name; group - The logger group

getGroup

public String getGroup()