org.neo4j.logging

Class FormattedLogProvider

java.lang.Object

org.neo4j.logging.AbstractLogProvider<FormattedLog>

org.neo4j.logging.FormattedLogProvider

All Implemented Interfaces:

LogProvider

public class FormattedLogProvider
extends AbstractLogProvider<FormattedLog>

A LogProvider implementation that applies a simple formatting to each log message.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FormattedLogProvider.Builder A Builder for a FormattedLogProvider

Method Summary

Methods

Modifier and Type	Method and Description
static FormattedLogProvider	toOutputStream(OutputStream out) Creates a FormattedLogProvider instance that writes messages to an OutputStream.
static FormattedLogProvider	toOutputStream(org.neo4j.function.Supplier<OutputStream> outSupplier) Creates a FormattedLogProvider instance that writes messages to OutputStreams obtained from the specified Supplier.
static FormattedLogProvider	toPrintWriter(PrintWriter writer) Creates a FormattedLogProvider instance that writes messages to a PrintWriter.
static FormattedLogProvider	toPrintWriter(org.neo4j.function.Supplier<PrintWriter> writerSupplier) Creates a FormattedLogProvider instance that writes messages to PrintWriters obtained from the specified Supplier.
static FormattedLogProvider	toWriter(Writer writer) Creates a FormattedLogProvider instance that writes messages to a Writer.
static FormattedLogProvider.Builder	withDefaultLogLevel(Level level) Start creating a FormattedLogProvider with the specified log Level for all Logs by default.
static FormattedLogProvider.Builder	withoutAutoFlush() Start creating a FormattedLogProvider without auto flushing.
static FormattedLogProvider.Builder	withoutRenderingContext() Start creating a FormattedLogProvider which will not render the context (the class name or log name) in each output line.
static FormattedLogProvider.Builder	withTimeZone(TimeZone timezone) Start creating a FormattedLogProvider with the specified timezone for datestamps in the log
static FormattedLogProvider.Builder	withUTCTimeZone() Start creating a FormattedLogProvider with UTC timezone for datestamps in the log

Methods inherited from class org.neo4j.logging.AbstractLogProvider

getLog, getLog

Methods inherited from class java.lang.Object

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

Method Detail

withoutRenderingContext

public static FormattedLogProvider.Builder withoutRenderingContext()

Start creating a FormattedLogProvider which will not render the context (the class name or log name) in each output line. Use FormattedLogProvider.Builder.toOutputStream(java.io.OutputStream) to complete.

Returns:

a builder for a FormattedLogProvider

withUTCTimeZone

public static FormattedLogProvider.Builder withUTCTimeZone()

Start creating a FormattedLogProvider with UTC timezone for datestamps in the log

Returns:

a builder for a FormattedLogProvider

withTimeZone

public static FormattedLogProvider.Builder withTimeZone(TimeZone timezone)

Start creating a FormattedLogProvider with the specified timezone for datestamps in the log

Parameters:

timezone - the timezone to use for datestamps

Returns:

a builder for a FormattedLogProvider

withDefaultLogLevel

public static FormattedLogProvider.Builder withDefaultLogLevel(Level level)

Start creating a FormattedLogProvider with the specified log Level for all Logs by default. Use FormattedLogProvider.Builder.toOutputStream(java.io.OutputStream) to complete.

Parameters:

level - the log level to use as a default

Returns:

a builder for a FormattedLogProvider

withoutAutoFlush

public static FormattedLogProvider.Builder withoutAutoFlush()

Start creating a FormattedLogProvider without auto flushing. Use FormattedLogProvider.Builder.toOutputStream(java.io.OutputStream) to complete.

Returns:

a builder for a FormattedLogProvider

toOutputStream

public static FormattedLogProvider toOutputStream(OutputStream out)

Creates a FormattedLogProvider instance that writes messages to an OutputStream.

Parameters:

out - An OutputStream to write to

Returns:

A FormattedLogProvider instance that writes to the specified OutputStream

toOutputStream

public static FormattedLogProvider toOutputStream(org.neo4j.function.Supplier<OutputStream> outSupplier)

Creates a FormattedLogProvider instance that writes messages to OutputStreams obtained from the specified Supplier. The OutputStream is obtained from the Supplier before every log message is written.

Parameters:

outSupplier - A supplier for an output stream to write to

Returns:

A FormattedLogProvider instance

toWriter

public static FormattedLogProvider toWriter(Writer writer)

Creates a FormattedLogProvider instance that writes messages to a Writer.

Parameters:

writer - A Writer to write to

Returns:

A FormattedLogProvider instance that writes to the specified Writer

toPrintWriter

public static FormattedLogProvider toPrintWriter(PrintWriter writer)

Creates a FormattedLogProvider instance that writes messages to a PrintWriter.

Parameters:

writer - A PrintWriter to write to

Returns:

A FormattedLogProvider instance that writes to the specified PrintWriter

toPrintWriter

public static FormattedLogProvider toPrintWriter(org.neo4j.function.Supplier<PrintWriter> writerSupplier)

Creates a FormattedLogProvider instance that writes messages to PrintWriters obtained from the specified Supplier. The PrintWriter is obtained from the Supplier before every log message is written.

Parameters:

writerSupplier - A supplier for a PrintWriter to write to

Returns:

A FormattedLogProvider instance that writes to the specified PrintWriter