net.pwall.log

Class PrintStreamAppender<F extends LogFormatter>

java.lang.Object

net.pwall.log.PrintStreamAppender<F>

Type Parameters:

F - the LogFormatter type

All Implemented Interfaces:

AutoCloseable, IntConsumer, LogAppender<F>

public class PrintStreamAppender<F extends LogFormatter>
extends Object
implements LogAppender<F>, IntConsumer

A LogAppender that writes to a PrintStream.

Author:

Peter Wall

Field Summary

Fields

Modifier and Type	Field and Description
static PrintStream	defaultOutput Default output stream for ConsoleLogger

Constructor Summary

Constructors

Constructor and Description
PrintStreamAppender(F formatter) Construct a PrintStreamAppender with the default PrintStream and the specified LogFormatter.
PrintStreamAppender(PrintStream stream, F formatter) Construct a PrintStreamAppender with the specified PrintStream and LogFormatter.

Method Summary

Modifier and Type	Method and Description
void	accept(int ch) Output a single character.
void	close() Close the PrintStreamAppender.
static PrintStreamAppender<BasicFormatter>	getBasic() Get a PrintStreamAppender for the default PrintStream using a BasicFormatter.
static PrintStreamAppender<BasicFormatter>	getBasic(PrintStream stream) Get a PrintStreamAppender for the nominated PrintStream using a BasicFormatter.
F	getFormatter() Get the LogFormatter used by this LogAppender.
void	output(long millis, net.pwall.log.Logger logger, net.pwall.log.Level level, Object message, Throwable throwable) Output a log message.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.IntConsumer

andThen

Field Detail

defaultOutput

public static final PrintStream defaultOutput

Default output stream for ConsoleLogger

Constructor Detail

PrintStreamAppender

public PrintStreamAppender(PrintStream stream,
                           F formatter)

Construct a PrintStreamAppender with the specified PrintStream and LogFormatter.

Parameters:

stream - the PrintStream

formatter - the LogFormatter

PrintStreamAppender

public PrintStreamAppender(F formatter)

Construct a PrintStreamAppender with the default PrintStream and the specified LogFormatter.

Parameters:

formatter - the LogFormatter

Method Detail

getFormatter

public F getFormatter()

Description copied from interface: LogAppender

Get the LogFormatter used by this LogAppender.

Specified by:

getFormatter in interface LogAppender<F extends LogFormatter>

Returns:

the LogFormatter

output

public void output(long millis,
                   net.pwall.log.Logger logger,
                   net.pwall.log.Level level,
                   Object message,
                   Throwable throwable)

Output a log message.

Specified by:

output in interface LogAppender<F extends LogFormatter>

Parameters:

millis - the time of the event in milliseconds from the standard era

logger - the Logger

level - the Level

message - the message

throwable - an optional Throwable

accept

public void accept(int ch)

Output a single character. This function satisfies the IntConsumer interface required by the LogFormatter. When a newline is output, the function uses the PrintStream.println() function, which will cause the operating-system-dependent form of line ending to be used (and will also flush the output).

Specified by:

accept in interface IntConsumer

Parameters:

ch - the character

close

public void close()

Close the PrintStreamAppender. Closes the underlying PrintStream. The appender does not check whether the PrintStream has been closed, so attempts to use it after close() has been called will result in unpredictable behaviour.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface LogAppender<F extends LogFormatter>

getBasic

public static PrintStreamAppender<BasicFormatter> getBasic(PrintStream stream)

Get a PrintStreamAppender for the nominated PrintStream using a BasicFormatter.

Parameters:

stream - the PrintStream

Returns:

the PrintStreamAppender

getBasic

public static PrintStreamAppender<BasicFormatter> getBasic()

Get a PrintStreamAppender for the default PrintStream using a BasicFormatter.

Returns:

the PrintStreamAppender