tijos.framework.util.logging

Class Logger

java.lang.Object

tijos.framework.util.logging.Logger

public class Logger
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALL The ALL level is used as a threshold for filtering log records, meaning that every message should be logged.
static int	CONFIG Log records whose level is CONFIG are used for describing the static configuration, for example the windowing environment, the operating system version, etc.
static int	INFO Log records whose level is INFO are used in purely informational situations that do not constitute serious errors or potential problems.
static int	OFF The OFF level is used as a threshold for filtering log records, meaning that no message should be logged.
static int	SEVERE Log records whose level is SEVERE indicate a serious failure that prevents normal program execution.
static int	WARNING Log records whose level is WARNING indicate a potential problem that does not prevent normal program execution.

Method Summary

Modifier and Type	Method and Description
static void	config(String componentName, String message) Logs a message with severity level CONFIG.
int	getLevel() Returns the severity level threshold for this Handler.
static Logger	getLogger()
String	getName() Returns the name of this logger.
static void	info(String componentName, String message) Logs a message with severity level INFO.
boolean	isLoggable(int level) Returns whether or not a message of the specified level would be logged by this logger.
void	log(String component, int level, String message)
void	log(String component, int level, String message, Object param)
void	logp(String component, int level, String message, Object[] params)
void	setLevel(int level) Sets the severity level threshold for this Handler.
void	setName(String subSystem)
static void	severe(String componentName, String message) Logs a message with severity level SEVERE, indicating a serious failure that prevents normal program execution.
static void	warning(String componentName, String message) Logs a message with severity level WARNING, indicating a potential problem that does not prevent normal program execution.

Methods inherited from class java.lang.Object

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

Field Detail

ALL

public static final int ALL

The ALL level is used as a threshold for filtering log records, meaning that every message should be logged.

See Also:

Constant Field Values

CONFIG

public static final int CONFIG

Log records whose level is CONFIG are used for describing the static configuration, for example the windowing environment, the operating system version, etc.

See Also:

Constant Field Values

INFO

public static final int INFO

Log records whose level is INFO are used in purely informational situations that do not constitute serious errors or potential problems. In the default logging configuration, INFO messages will be written to the system console. For this reason, the INFO level should be used only for messages that are important to end users and system administrators. Messages at this level should be understandable to an inexperienced, non-technical user.

See Also:

Constant Field Values

OFF

public static final int OFF

The OFF level is used as a threshold for filtering log records, meaning that no message should be logged.

See Also:

Constant Field Values

SEVERE

public static final int SEVERE

Log records whose level is SEVERE indicate a serious failure that prevents normal program execution. Messages at this level should be understandable to an inexperienced, non-technical end user. Ideally, they explain in simple words what actions the user can take in order to resolve the problem.

See Also:

Constant Field Values

WARNING

public static final int WARNING

Log records whose level is WARNING indicate a potential problem that does not prevent normal program execution. Messages at this level should be understandable to an inexperienced, non-technical end user. Ideally, they explain in simple words what actions the user can take in order to resolve the problem.

See Also:

Constant Field Values

Method Detail

config

public static void config(String componentName,
                          String message)

Logs a message with severity level CONFIG. is intended for static configuration messages, for example about the windowing environment, the operating system version, etc.

Parameters:

componentName - the component name where the message is from.

message - the message text, also used as look-up key if the logger is localizing messages with a resource bundle. While it is possible to pass null, this is not recommended, since a logging message without text is unlikely to be helpful.

getLevel

public int getLevel()

Returns the severity level threshold for this Handler. All log records with a lower severity level will be discarded; a log record of the same or a higher level will be published unless an installed Filter decides to discard it.

Returns:

the severity level below which all log messages will be discarded, or null if the logger inherits the threshold from its parent.

getLogger

public static Logger getLogger()

getName

public String getName()

Returns the name of this logger.

Returns:

the name of this logger, or null if the logger is anonymous.

info

public static void info(String componentName,
                        String message)

Logs a message with severity level INFO. is intended for purely informational messages that do not indicate error or warning situations. In the default logging configuration, INFO messages will be written to the system console. For this reason, the INFO level should be used only for messages that are important to end users and system administrators. Messages at this level should be understandable to an inexperienced, non-technical user.

Parameters:

componentName - the component name where the message is from.

message - the message text, also used as look-up key if the logger is localizing messages with a resource bundle. While it is possible to pass null, this is not recommended, since a logging message without text is unlikely to be helpful.

isLoggable

public boolean isLoggable(int level)

Returns whether or not a message of the specified level would be logged by this logger.

Parameters:

level - specified level for checking

Returns:

if logable

Throws:

NullPointerException - if level is null.

log

public void log(String component,
                int level,
                String message)

log

public void log(String component,
                int level,
                String message,
                Object param)

logp

public void logp(String component,
                 int level,
                 String message,
                 Object[] params)

setLevel

public void setLevel(int level)

Sets the severity level threshold for this Handler. All log records with a lower severity level will be discarded immediately. A log record of the same or a higher level will be published unless an installed Filter decides to discard it.

Parameters:

level - the severity level below which all log messages will be discarded, or null to indicate that the logger should inherit the threshold from its parent.

setName

public void setName(String subSystem)

severe

public static void severe(String componentName,
                          String message)

Logs a message with severity level SEVERE, indicating a serious failure that prevents normal program execution. Messages at this level should be understandable to an inexperienced, non-technical end user. Ideally, they explain in simple words what actions the user can take in order to resolve the problem.

Parameters:

componentName - the component name where the message is from.

message - the message text, also used as look-up key if the logger is localizing messages with a resource bundle. While it is possible to pass null, this is not recommended, since a logging message without text is unlikely to be helpful.

warning

public static void warning(String componentName,
                           String message)

Logs a message with severity level WARNING, indicating a potential problem that does not prevent normal program execution. Messages at this level should be understandable to an inexperienced, non-technical end user. Ideally, they explain in simple words what actions the user can take in order to resolve the problem.

Parameters:

componentName - the component name where the message is from.

message - the message text, also used as look-up key if the logger is localizing messages with a resource bundle. While it is possible to pass null, this is not recommended, since a logging message without text is unlikely to be helpful.