Copyright (C) 2013 Andrei Olaru under the GNU General Public License. See http://www.gnu.org/licenses/.
A C D E G I L M N O P R S T U V W 

A

ARGUMENT_BEGIN - Static variable in interface net.xqhs.util.logging.LoggerSimple
The string to be added before the rendition of the argument in the message string.
ARGUMENT_END - Static variable in interface net.xqhs.util.logging.LoggerSimple
The string to be added after the rendition of the argument in the message string.
ARGUMENT_PLACEHOLDER - Static variable in interface net.xqhs.util.logging.LoggerSimple
The substring in the message string that will be replaced with the various specified arguments.

C

compose(String, Object[]) - Static method in class net.xqhs.util.logging.Unit
Composes a message with an array of Object instances.

D

dbg(Debug.DebugItem, String, Object...) - Method in interface net.xqhs.util.logging.LoggerSimple
Outputs a fine logging message only if the specified Debug.DebugItem is activated.
dbg(Debug.DebugItem, String, Object...) - Method in class net.xqhs.util.logging.Unit
This method displays a log message (with the level TRACE) only if the specified Debug.DebugItem is activated.
dbg(Debug.DebugItem, String, Object...) - Method in class net.xqhs.util.logging.UnitComponent
 
Debug - Class in net.xqhs.util.logging
Class containing different debug items that can be activated or deactivated by editing this class.
Debug() - Constructor for class net.xqhs.util.logging.Debug
 
Debug.DebugItem - Interface in net.xqhs.util.logging
This interface must be implemented by all enumerations of debug constants in order to be able to use them as arguments of method dbg() in LoggerSimple implementations.
Debug.LocalDebugItem - Enum in net.xqhs.util.logging
Example enumeration implementing Debug.DebugItem.
Debug.LocalDebugItem(boolean) - Constructor for enum net.xqhs.util.logging.Debug.LocalDebugItem
Default constructor.
DEFAULT_LEVEL - Static variable in class net.xqhs.util.logging.Unit
The default level for the log, if no other level is set.
DEFAULT_UNIT_NAME - Static variable in class net.xqhs.util.logging.Unit
The value that should be used to state that the name of the unit should be computed depending on the class name.
display - Variable in class net.xqhs.util.logging.Unit
A DisplayEntity implementation to which to post logging information.
DisplayEntity - Interface in net.xqhs.util.logging
Interface for an entity that is able to display the log (e.g.
displayWith(LoggerSimple.Level) - Method in enum net.xqhs.util.logging.LoggerSimple.Level
Returns true if a message with this level should be displayed if the level of the log is logLevel.
doExit() - Method in class net.xqhs.util.logging.Unit
Instructs the Unit to exit.
doExit() - Method in class net.xqhs.util.logging.UnitComponent
 

E

ensureNew - Variable in class net.xqhs.util.logging.Unit
If true, then if another log exists with the same name, an error will be produced.
error(String, Object...) - Method in interface net.xqhs.util.logging.Logger
error(String, Object...) - Method in class net.xqhs.util.logging.UnitComponentExt
 
error(String, Object...) - Method in class net.xqhs.util.logging.UnitExt
exitTogether - Variable in class net.xqhs.util.logging.UnitLinkData
 

G

getDefaultUnitName() - Method in class net.xqhs.util.logging.Unit
This method is meant to be overridden in inheriting classes, so as to give the default name for units of that type.
getUnitName() - Method in class net.xqhs.util.logging.Unit
This method is only accessible inside the instance, except if for good reasons an extending class makes it public.
getUnitName() - Method in class net.xqhs.util.logging.UnitComponent
 

I

includeInParent - Variable in class net.xqhs.util.logging.UnitLinkData
 
info(String, Object...) - Method in interface net.xqhs.util.logging.Logger
info(String, Object...) - Method in class net.xqhs.util.logging.UnitComponentExt
 
info(String, Object...) - Method in class net.xqhs.util.logging.UnitExt
isset - Variable in enum net.xqhs.util.logging.Debug.LocalDebugItem
Activation state.

L

l(LoggerSimple.Level, String, Object...) - Method in class net.xqhs.util.logging.Unit
This method calls the underlying logging infrastructure to display a message with the specified level, text, and parameter objects.
le(String, Object...) - Method in interface net.xqhs.util.logging.LoggerSimple
Outputs an error message.
le(String, Object...) - Method in class net.xqhs.util.logging.Unit
Post an error message.
le(String, Object...) - Method in class net.xqhs.util.logging.UnitComponent
 
level - Variable in class net.xqhs.util.logging.Unit
The current level of the log.
lf(String, Object...) - Method in interface net.xqhs.util.logging.LoggerSimple
Outputs a 'fine' logging message.
lf(String, Object...) - Method in class net.xqhs.util.logging.Unit
Post a tracing message.
lf(String, Object...) - Method in class net.xqhs.util.logging.UnitComponent
 
li(String, Object...) - Method in interface net.xqhs.util.logging.LoggerSimple
Outputs an info message.
li(String, Object...) - Method in class net.xqhs.util.logging.Unit
Post an informative message.
li(String, Object...) - Method in class net.xqhs.util.logging.UnitComponent
 
linkData - Variable in class net.xqhs.util.logging.Unit
Information on linking the behavior of this log to other logs.
lock() - Method in class net.xqhs.util.logging.Unit
Constructs a Unit according to the previously given parameters.
lockedR() - Method in class net.xqhs.util.logging.Unit
Calls the Config.locked() method and if an exception is thrown it posts an error message to the log.
log - Variable in class net.xqhs.util.logging.Unit
The LogWrapper that will be used for logging.
Logger - Interface in net.xqhs.util.logging
Any class that offers logging services to an external entity should implement this interface.
LoggerSimple - Interface in net.xqhs.util.logging
Any class that offers simple logging services (lf-li-lw-le-lr-dbg) to an external entity should implement this interface.
LoggerSimple.Level - Enum in net.xqhs.util.logging
Indicates the level of the log.
LoggerSimple.Level(int) - Constructor for enum net.xqhs.util.logging.LoggerSimple.Level
Creates a new level, with a set priority.
loggerWrapperClass - Variable in class net.xqhs.util.logging.Unit
The class of the logging wrapper that will be used (used only if different from the default types specified by LogWrapper.LoggerType.
loggerWrapperType - Variable in class net.xqhs.util.logging.Unit
The type of the logging wrapper that will be used.
logName - Variable in class net.xqhs.util.logging.Unit
The name that will be given to the log.
lr(Object) - Method in interface net.xqhs.util.logging.LoggerSimple
Outputs a fine logging message just before returning the Object in the argument.
lr(Object, String, Object...) - Method in interface net.xqhs.util.logging.LoggerSimple
Outputs a fine logging message just before returning the Object in the argument.
lr(Object) - Method in class net.xqhs.util.logging.Unit
This method should be used in return statements.
lr(Object, String, Object...) - Method in class net.xqhs.util.logging.Unit
This method should be used in return statements.
lr(Object) - Method in class net.xqhs.util.logging.UnitComponent
 
lr(Object, String, Object...) - Method in class net.xqhs.util.logging.UnitComponent
 
lw(String, Object...) - Method in interface net.xqhs.util.logging.LoggerSimple
Outputs a warning message.
lw(String, Object...) - Method in class net.xqhs.util.logging.Unit
Post a warning message.
lw(String, Object...) - Method in class net.xqhs.util.logging.UnitComponent
 

M

makeClassName(boolean) - Method in class net.xqhs.util.logging.Unit
Gets the name of the current class, using either the canonical name or the simple name, depending on the argument.

N

net.xqhs.util.logging - package net.xqhs.util.logging
This package contains the classes and interfaces for the net.xqhs.Logging logging infrastructure.

O

output(String) - Method in interface net.xqhs.util.logging.DisplayEntity
The method is called whenever new logging information is posted.

P

parentLogName - Variable in class net.xqhs.util.logging.UnitLinkData
The name of the parent LogWrapper.
prefix - Variable in class net.xqhs.util.logging.UnitLinkData
 
priority - Variable in enum net.xqhs.util.logging.LoggerSimple.Level
The priority of the level.

R

report(String) - Method in interface net.xqhs.util.logging.ReportingEntity
The method will be called at intervals of reportUpdateDelay, if new logging information exist since the last call.
reporter - Variable in class net.xqhs.util.logging.Unit
A ReportingEntity implementation to which to post logging information.
ReportingEntity - Interface in net.xqhs.util.logging
Interface for an entity / unit that keeps a log and that needs to report that log to other entities.

S

setLink(String) - Method in class net.xqhs.util.logging.Unit
Sets the name of the parent log.
setLink(UnitLinkData) - Method in class net.xqhs.util.logging.Unit
Sets the information on linking this unit to another log.
setLogDisplay(DisplayEntity) - Method in class net.xqhs.util.logging.Unit
Sets the DisplayEntity to receive updates form the log.
setLogEnsureNew() - Method in class net.xqhs.util.logging.Unit
If called, when the log is created, if another log exists with the same name, an error will be produced.
setLoggerClass(String) - Method in class net.xqhs.util.logging.Unit
Sets the class of the wrapper for the underlying logger.
setLoggerType(LogWrapper.LoggerType) - Method in class net.xqhs.util.logging.Unit
Sets the type of the logging infrastructure and wrapper used by this unit.
setLoggerTypeClass(LogWrapper.LoggerType, String) - Method in class net.xqhs.util.logging.Unit
Setter for the logger type / logger wrapper class.
setLogLevel(LoggerSimple.Level) - Method in class net.xqhs.util.logging.Unit
Sets the level of the log, as one of LoggerSimple.Level.
setLogReporter(ReportingEntity) - Method in class net.xqhs.util.logging.Unit
Sets the ReportingEntity to receive updates from the log.
setparentLogName(String) - Method in class net.xqhs.util.logging.UnitLinkData
 
setUnitName(String) - Method in class net.xqhs.util.logging.Unit
Sets the name of the unit (and therefore of the log).
setUnitName(String, boolean, boolean) - Method in class net.xqhs.util.logging.Unit
Sets the name of the unit (and therefore of the log).
setUnitName(String, boolean, boolean, boolean) - Method in class net.xqhs.util.logging.Unit
Aggregates parameters from the two other version of the method.

T

toBool() - Method in interface net.xqhs.util.logging.Debug.DebugItem
Computes the activation state of the constant.
toBool() - Method in enum net.xqhs.util.logging.Debug.LocalDebugItem
 
trace(String, Object...) - Method in interface net.xqhs.util.logging.Logger
trace(String, Object...) - Method in class net.xqhs.util.logging.UnitComponentExt
 
trace(String, Object...) - Method in class net.xqhs.util.logging.UnitExt

U

Unit - Class in net.xqhs.util.logging
The Unit class should be extended by classes in which logging primitives should be available without calling a specific instance.
Unit() - Constructor for class net.xqhs.util.logging.Unit
Constructs a new Unit.
UnitComponent - Class in net.xqhs.util.logging
A class that extends Unit and exposes the logging methods.
UnitComponent() - Constructor for class net.xqhs.util.logging.UnitComponent
 
UnitComponentExt - Class in net.xqhs.util.logging
The class extends UnitExt to implement all methods required by the Logger interface and expose all methods as public.
UnitComponentExt() - Constructor for class net.xqhs.util.logging.UnitComponentExt
 
UnitExt - Class in net.xqhs.util.logging
This class extends Unit in order to provide all functionality required by the Logger interface.
UnitExt() - Constructor for class net.xqhs.util.logging.UnitExt
 
UnitLinkData - Class in net.xqhs.util.logging
A sub-configuration for linking the configured LogWrapper to another the "parent".
UnitLinkData() - Constructor for class net.xqhs.util.logging.UnitLinkData
 
unitName - Variable in class net.xqhs.util.logging.Unit
The name of the Unit.

V

valueOf(String) - Static method in enum net.xqhs.util.logging.Debug.LocalDebugItem
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum net.xqhs.util.logging.LoggerSimple.Level
Returns the enum constant of this type with the specified name.
values() - Static method in enum net.xqhs.util.logging.Debug.LocalDebugItem
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.xqhs.util.logging.LoggerSimple.Level
Returns an array containing the constants of this enum type, in the order they are declared.

W

warn(String, Object...) - Method in interface net.xqhs.util.logging.Logger
warn(String, Object...) - Method in class net.xqhs.util.logging.UnitComponentExt
 
warn(String, Object...) - Method in class net.xqhs.util.logging.UnitExt
A C D E G I L M N O P R S T U V W 
Copyright (C) 2013 Andrei Olaru under the GNU General Public License. See http://www.gnu.org/licenses/.