org.logl.logl

Class SimpleLogger

java.lang.Object

org.logl.logl.SimpleLogger

public final class SimpleLogger
extends java.lang.Object

Factory methods for creating loggers that writes log lines using a common log format.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimpleLogger.Builder A builder for a logger that uses a common log format.

Method Summary

Modifier and Type	Method and Description
static AdjustableLoggerProvider	toOutputStream(java.io.OutputStream stream) Return a provider for simple loggers that write to the supplied OutputStream.
static AdjustableLoggerProvider	toPrintWriter(java.io.PrintWriter writer) Return a provider for simple loggers that write to the supplied PrintWriter.
static AdjustableLoggerProvider	toPrintWriter(java.util.function.Supplier<java.io.PrintWriter> writerSupplier) Return a provider for simple loggers that write to the supplied PrintWriter.
static SimpleLogger.Builder	withLocale(java.util.Locale locale) Start building a simple logger that uses the specified locale for message output.
static SimpleLogger.Builder	withLogLevel(Level level) Start building a simple logger that writes log lines at or above the specified level.
static SimpleLogger.Builder	withoutAutoFlush() Start building a simple logger that does not flush the output after each write.
static SimpleLogger.Builder	withZone(java.time.ZoneId timeZone) Start building a simple logger that uses the specified timezone for timestamps.

Methods inherited from class java.lang.Object

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

Method Detail

withZone

public static SimpleLogger.Builder withZone(java.time.ZoneId timeZone)

Start building a simple logger that uses the specified timezone for timestamps.

Parameters:

timeZone - The timezone to use for timestamps.

Returns:

A builder for a simple logger.

withLocale

public static SimpleLogger.Builder withLocale(java.util.Locale locale)

Start building a simple logger that uses the specified locale for message output.

Parameters:

locale - The locale to use for message output.

Returns:

A builder for a simple logger.

withLogLevel

public static SimpleLogger.Builder withLogLevel(Level level)

Start building a simple logger that writes log lines at or above the specified level.

Parameters:

level - The level at or above which log lines will be output.

Returns:

A builder for a simple logger.

withoutAutoFlush

public static SimpleLogger.Builder withoutAutoFlush()

Start building a simple logger that does not flush the output after each write.

Returns:

A builder for a simple logger.

toPrintWriter

public static AdjustableLoggerProvider toPrintWriter(java.io.PrintWriter writer)

Return a provider for simple loggers that write to the supplied PrintWriter.

Parameters:

writer - A PrintWriter to output log lines to.

Returns:

A AdjustableLoggerProvider that provides Logger instances using a common log format.

toOutputStream

public static AdjustableLoggerProvider toOutputStream(java.io.OutputStream stream)

Return a provider for simple loggers that write to the supplied OutputStream.

This convenience method creates the necessary intermediate OutputStreamWriter, which will convert characters into bytes using the UTF-8 character encoding.

Parameters:

stream - An OutputStream to output log lines to.

Returns:

A AdjustableLoggerProvider that provides Logger instances using a common log format.

toPrintWriter

public static AdjustableLoggerProvider toPrintWriter(java.util.function.Supplier<java.io.PrintWriter> writerSupplier)

Return a provider for simple loggers that write to the supplied PrintWriter.

Parameters:

writerSupplier - A Supplier for a PrintWriter, where log lines will be output to.

Returns:

A AdjustableLoggerProvider that provides Logger instances using a common log format.