net.xqhs.util.logging

Class UnitComponent

java.lang.Object

net.xqhs.util.config.Config

net.xqhs.util.logging.Unit

net.xqhs.util.logging.UnitComponent

All Implemented Interfaces:

net.xqhs.util.config.Configurable, LoggerSimple

Direct Known Subclasses:

UnitComponentExt

public class UnitComponent
extends Unit
implements LoggerSimple

A class that extends Unit and exposes the logging methods. See Unit for details. It implements LoggerSimple.

This allows a class to use the functionality of a Unit without extending Unit.

Author:

Andrei Olaru

Nested Class Summary

Nested classes/interfaces inherited from class net.xqhs.util.config.Config

net.xqhs.util.config.Config.ConfigLockedException

Nested classes/interfaces inherited from interface net.xqhs.util.logging.LoggerSimple

LoggerSimple.Level

Field Summary

Fields inherited from class net.xqhs.util.logging.Unit

DEFAULT_LEVEL, DEFAULT_UNIT_NAME, display, ensureNew, level, linkData, log, loggerWrapperClass, loggerWrapperType, logName, reporter, unitName

Fields inherited from interface net.xqhs.util.logging.LoggerSimple

ARGUMENT_BEGIN, ARGUMENT_END, ARGUMENT_PLACEHOLDER

Constructor Summary

Constructors

Constructor and Description
UnitComponent()

Method Summary

Methods

Modifier and Type	Method and Description
void	dbg(Debug.DebugItem debug, java.lang.String message, java.lang.Object... arguments) This method displays a log message (with the level TRACE) only if the specified Debug.DebugItem is activated.
void	doExit() Instructs the Unit to exit.
java.lang.String	getUnitName() This method is only accessible inside the instance, except if for good reasons an extending class makes it public.
void	le(java.lang.String message, java.lang.Object... arguments) Post an error message.
void	lf(java.lang.String message, java.lang.Object... arguments) Post a tracing message.
void	li(java.lang.String message, java.lang.Object... arguments) Post an informative message.
java.lang.Object	lr(java.lang.Object ret) This method should be used in return statements.
java.lang.Object	lr(java.lang.Object ret, java.lang.String message, java.lang.Object... arguments) This method should be used in return statements.
void	lw(java.lang.String message, java.lang.Object... arguments) Post a warning message.

Methods inherited from class net.xqhs.util.logging.Unit

compose, getDefaultUnitName, l, lock, lockedR, setLink, setLink, setLogDisplay, setLogEnsureNew, setLoggerClass, setLoggerType, setLoggerTypeClass, setLogLevel, setLogReporter, setUnitName, setUnitName

Methods inherited from class net.xqhs.util.config.Config

build, ensureLocked, locked, lockEx, makeDefaults

Methods inherited from class java.lang.Object

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

Constructor Detail

UnitComponent

public UnitComponent()

Method Detail

le

public void le(java.lang.String message,
      java.lang.Object... arguments)

Description copied from class: Unit

Post an error message. See LoggerSimple.

Specified by:

le in interface LoggerSimple

Overrides:

le in class Unit

Parameters:

message - : the message to display

arguments - : arguments to insert into the message. See LoggerSimple.

lw

public void lw(java.lang.String message,
      java.lang.Object... arguments)

Description copied from class: Unit

Post a warning message. See LoggerSimple.

Specified by:

lw in interface LoggerSimple

Overrides:

lw in class Unit

Parameters:

message - : the message to display

arguments - : arguments to insert into the message. See LoggerSimple.

li

public void li(java.lang.String message,
      java.lang.Object... arguments)

Description copied from class: Unit

Post an informative message. See LoggerSimple.

Specified by:

li in interface LoggerSimple

Overrides:

li in class Unit

Parameters:

message - : the message to display

arguments - : arguments to insert into the message. See LoggerSimple.

lf

public void lf(java.lang.String message,
      java.lang.Object... arguments)

Description copied from class: Unit

Post a tracing message. See LoggerSimple.

Specified by:

lf in interface LoggerSimple

Overrides:

lf in class Unit

Parameters:

message - : the message to display

arguments - : arguments to insert into the message. See LoggerSimple.

lr

public java.lang.Object lr(java.lang.Object ret)

Description copied from class: Unit

This method should be used in return statements. It adds a log message just before returning the Object in the argument, displaying the Object. See LoggerSimple.

Specified by:

lr in interface LoggerSimple

Overrides:

lr in class Unit

Parameters:

ret - : the Object to return.

Returns:

the Object passed as argument.

lr

public java.lang.Object lr(java.lang.Object ret,
                  java.lang.String message,
                  java.lang.Object... arguments)

Description copied from class: Unit

This method should be used in return statements. It adds a log message just before returning the Object in the argument. See LoggerSimple.

The Object in the argument is also put in the log message.

Specified by:

lr in interface LoggerSimple

Overrides:

lr in class Unit

Parameters:

ret - : the Object to return and to display.

message - : the message to display beside the Object.

arguments - : arguments to insert into the message. See LoggerSimple.

Returns:

the Object passed as argument.

dbg

public void dbg(Debug.DebugItem debug,
       java.lang.String message,
       java.lang.Object... arguments)

Description copied from class: Unit

This method displays a log message (with the level TRACE) only if the specified Debug.DebugItem is activated. See LoggerSimple.

Specified by:

dbg in interface LoggerSimple

Overrides:

dbg in class Unit

Parameters:

debug - : the Debug.DebugItem

message - : the log message

arguments - : arguments to insert into the message. See LoggerSimple.

doExit

public void doExit()

Description copied from class: Unit

Instructs the Unit to exit. This method is only accessible inside the instance, except if for good reasons an extending class makes it public.

As the Unit layer only manages logging, the only thing that happens is that the log exits (if any).

Overrides:

doExit in class Unit

getUnitName

public java.lang.String getUnitName()

Description copied from class: Unit

This method is only accessible inside the instance, except if for good reasons an extending class makes it public.

Overrides:

getUnitName in class Unit

Returns:

the Unit name, as given to or set in the constructor.