Package java.util.logging

Class Handler

java.lang.Object

java.util.logging.Handler

Direct Known Subclasses:

MemoryHandler, StreamHandler

public abstract class Handler
extends Object

A Handler object accepts a logging request and exports the desired messages to a target, for example, a file, the console, etc. It can be disabled by setting its logging level to Level.OFF.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Handler()	Constructs a Handler object with a default error manager instance ErrorManager, the default encoding, and the default logging level Level.ALL.

Method Summary

Modifier and Type	Method	Description
abstract void	close()	Closes this handler.
abstract void	flush()	Flushes any buffered output.
String	getEncoding()	Gets the character encoding used by this handler, null for default encoding.
ErrorManager	getErrorManager()	Gets the error manager used by this handler to report errors during logging.
Filter	getFilter()	Gets the filter used by this handler.
Formatter	getFormatter()	Gets the formatter used by this handler to format the logging messages.
Level	getLevel()	Gets the logging level of this handler, records with levels lower than this value will be dropped.
boolean	isLoggable(LogRecord record)	Determines whether the supplied log record needs to be logged.
abstract void	publish(LogRecord record)	Accepts a logging request and sends it to the the target.
protected void	reportError(String msg, Exception ex, int code)	Reports an error to the error manager associated with this handler, ErrorManager is used for that purpose.
void	setEncoding(String charsetName)	Sets the character encoding used by this handler, null indicates a default encoding.
void	setErrorManager(ErrorManager newErrorManager)	Sets the error manager for this handler.
void	setFilter(Filter newFilter)	Sets the filter to be used by this handler.
void	setFormatter(Formatter newFormatter)	Sets the formatter to be used by this handler.
void	setLevel(Level newLevel)	Sets the logging level of the messages logged by this handler, levels lower than this value will be dropped.

Methods inherited from class java.lang.Object

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

Constructor Detail

Handler

protected Handler()

Constructs a Handler object with a default error manager instance ErrorManager, the default encoding, and the default logging level Level.ALL. It has no filter and no formatter.

Method Detail

close

public abstract void close()

Closes this handler. A flush operation will be performed and all the associated resources will be freed. Client applications should not use this handler after closing it.

flush

public abstract void flush()

Flushes any buffered output.

publish

public abstract void publish(LogRecord record)

Accepts a logging request and sends it to the the target.

Parameters:

record - the log record to be logged; null records are ignored.

getEncoding

public String getEncoding()

Gets the character encoding used by this handler, null for default encoding.

Returns:

the character encoding used by this handler.

getErrorManager

public ErrorManager getErrorManager()

Gets the error manager used by this handler to report errors during logging.

Returns:

the error manager used by this handler.

getFilter

public Filter getFilter()

Gets the filter used by this handler.

Returns:

the filter used by this handler (possibly null).

getFormatter

public Formatter getFormatter()

Gets the formatter used by this handler to format the logging messages.

Returns:

the formatter used by this handler (possibly null).

getLevel

public Level getLevel()

Gets the logging level of this handler, records with levels lower than this value will be dropped.

Returns:

the logging level of this handler.

isLoggable

public boolean isLoggable(LogRecord record)

Determines whether the supplied log record needs to be logged. The logging levels will be checked as well as the filter.

Parameters:

record - the log record to be checked.

Returns:

true if the supplied log record needs to be logged, otherwise false.

reportError

protected void reportError(String msg,
                           Exception ex,
                           int code)

Reports an error to the error manager associated with this handler, ErrorManager is used for that purpose. No security checks are done, therefore this is compatible with environments where the caller is non-privileged.

Parameters:

msg - the error message, may be null.

ex - the associated exception, may be null.

code - an ErrorManager error code.

setEncoding

public void setEncoding(String charsetName)
                 throws UnsupportedEncodingException

Sets the character encoding used by this handler, null indicates a default encoding.

Throws:

UnsupportedEncodingException - if charsetName is not supported.

setErrorManager

public void setErrorManager(ErrorManager newErrorManager)

Sets the error manager for this handler.

Parameters:

newErrorManager - the error manager to set.

Throws:

NullPointerException - if em is null.

setFilter

public void setFilter(Filter newFilter)

Sets the filter to be used by this handler.

Parameters:

newFilter - the filter to set, may be null.

setFormatter

public void setFormatter(Formatter newFormatter)

Sets the formatter to be used by this handler.

Parameters:

newFormatter - the formatter to set.

Throws:

NullPointerException - if newFormatter is null.

setLevel

public void setLevel(Level newLevel)

Sets the logging level of the messages logged by this handler, levels lower than this value will be dropped.

Parameters:

newLevel - the logging level to set.

Throws:

NullPointerException - if newLevel is null.