org.yarnandtail.andhow.util

Class AndHowLogHandler

java.lang.Object

java.util.logging.Handler

org.yarnandtail.andhow.util.AndHowLogHandler

public class AndHowLogHandler
extends Handler

Handles writing a java.util.Logger to a PrintStream, by default System.err for errors and System.out for non-errors.

Field Summary

Fields

Modifier and Type	Field and Description
static String	MANDATORY_NOTE_PREFIX Messages beginning with this prefix are important for users to see, but not an error.

Constructor Summary

Constructors

Constructor and Description
AndHowLogHandler()
AndHowLogHandler(PrintStream errStream, PrintStream outStream)

Method Summary

Modifier and Type	Method and Description
void	close()
void	flush()
PrintStream	getErrStream() Returns the PrintStream used for error level logging (java.util.logging SEVERE level).
PrintStream	getNonErrStream() Returns the PrintStream used for non-error level logging (java.util.logging WARNING and lower).
protected void	killStream(PrintStream printStream) Kills a PrintStream, first ensuring that it is not currently assigned to System.out or System.err.
void	publish(LogRecord record) Publish a message to either System.out or System.err based on the message Level.
protected void	publishMandatoryNote(LogRecord record) Publish a message that must be seen, but is not an error.
void	setErrStream(PrintStream errStream) Sets the PrintStream used for error level logging (java.util.logging SEVERE level).
void	setNonErrStream(PrintStream outStream) Sets the PrintStream used for non-error level logging (java.util.logging WARNING and lower).

Methods inherited from class java.util.logging.Handler

getEncoding, getErrorManager, getFilter, getFormatter, getLevel, isLoggable, reportError, setEncoding, setErrorManager, setFilter, setFormatter, setLevel

Methods inherited from class java.lang.Object

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

Field Detail

MANDATORY_NOTE_PREFIX

public static final String MANDATORY_NOTE_PREFIX

Messages beginning with this prefix are important for users to see, but not an error. This was created for the case where sample configuration was written to a tmp directory, possibly at the user's request. The message must be displayed or they won't know where it was written to, but it should not look like an error.

See Also:

Constant Field Values

Constructor Detail

AndHowLogHandler

public AndHowLogHandler()

AndHowLogHandler

public AndHowLogHandler(PrintStream errStream,
                        PrintStream outStream)

Method Detail

getErrStream

public PrintStream getErrStream()

Returns the PrintStream used for error level logging (java.util.logging SEVERE level).

Returns:

setErrStream

public void setErrStream(PrintStream errStream)

Sets the PrintStream used for error level logging (java.util.logging SEVERE level).

Setting to null will revert to the default error stream, which is System.err.

Parameters:

errStream -

getNonErrStream

public PrintStream getNonErrStream()

Returns the PrintStream used for non-error level logging (java.util.logging WARNING and lower).

Returns:

setNonErrStream

public void setNonErrStream(PrintStream outStream)

Sets the PrintStream used for non-error level logging (java.util.logging WARNING and lower).

Setting to null will revert to the default non-error stream, which is System.out.

Parameters:

outStream -

publishMandatoryNote

protected void publishMandatoryNote(LogRecord record)

Publish a message that must be seen, but is not an error.

This was created for the case where sample configuration is written to a tmp directory, possibly at the user's request. The message must be displayed or the user will not know where samples were written, but it should not look like an error.

Detection is be done by prefixing the message template text with MANDATORY_NOTE_PREFIX - this method assumes that detection has already been done. This method will remove MANDATORY_NOTE_PREFIX anywhere it is found in the message string template.

Parameters:

record - The mandatory note to publish to System.out or System.err

publish

public void publish(LogRecord record)

Publish a message to either System.out or System.err based on the message Level.

Message templates prefixed with MANDATORY_NOTE_PREFIX are passed directly to publishMandatoryNote(LogRecord). This is done before applying formatting.

Specified by:

publish in class Handler

Parameters:

record - The LogRecord to publish to System.out or System.err

flush

public void flush()

Specified by:

flush in class Handler

close

public void close()
           throws SecurityException

Specified by:

close in class Handler

Throws:

SecurityException

killStream

protected void killStream(PrintStream printStream)

Kills a PrintStream, first ensuring that it is not currently assigned to System.out or System.err.

Parameters:

printStream -