org.neo4j.logging

Class FormattedLogProvider.Builder

java.lang.Object

org.neo4j.logging.FormattedLogProvider.Builder

Enclosing class:

FormattedLogProvider

public static class FormattedLogProvider.Builder
extends Object

A Builder for a FormattedLogProvider

Method Summary

Modifier and Type	Method and Description
FormattedLogProvider	toOutputStream(OutputStream out) Creates a FormattedLogProvider instance that writes messages to an OutputStream.
FormattedLogProvider	toOutputStream(Supplier<OutputStream> outSupplier) Creates a FormattedLogProvider instance that writes messages to OutputStreams obtained from the specified Supplier.
FormattedLogProvider	toPrintWriter(PrintWriter writer) Creates a FormattedLogProvider instance that writes messages to a PrintWriter.
FormattedLogProvider	toPrintWriter(Supplier<PrintWriter> writerSupplier) Creates a FormattedLogProvider instance that writes messages to PrintWriters obtained from the specified Supplier.
FormattedLogProvider	toWriter(Writer writer) Creates a FormattedLogProvider instance that writes messages to a Writer.
FormattedLogProvider.Builder	withDefaultLogLevel(Level level) Use the specified log Level for all Logs by default.
FormattedLogProvider.Builder	withLogLevel(String context, Level level) Use the specified log Level for any Logs that match the specified context.
FormattedLogProvider.Builder	withLogLevels(Map<String,Level> levels) Set the log level for many contexts - equivalent to calling withLogLevel(String, Level) for every entry in the provided map.
FormattedLogProvider.Builder	withoutAutoFlush() Disable auto flushing.
FormattedLogProvider.Builder	withoutRenderingContext() Disable rendering of the context (the class name or log name) in each output line.
FormattedLogProvider.Builder	withTimeZone(TimeZone timezone) Deprecated. use withZoneId(ZoneId)
FormattedLogProvider.Builder	withUTCZoneId() Set the zoneId for datestamps in the log
FormattedLogProvider.Builder	withZoneId(ZoneId zoneId) Set the zoneId for datestamps in the log

Methods inherited from class java.lang.Object

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

Method Detail

withoutRenderingContext

public FormattedLogProvider.Builder withoutRenderingContext()

Disable rendering of the context (the class name or log name) in each output line.

Returns:

this builder

withUTCZoneId

public FormattedLogProvider.Builder withUTCZoneId()

Set the zoneId for datestamps in the log

Returns:

this builder

withZoneId

public FormattedLogProvider.Builder withZoneId(ZoneId zoneId)

Set the zoneId for datestamps in the log

Parameters:

zoneId -

Returns:

this builder

withTimeZone

@Deprecated
public FormattedLogProvider.Builder withTimeZone(TimeZone timezone)

Deprecated. use withZoneId(ZoneId)

Set the zoneId from timestamp for datestamps in the log

Parameters:

timezone -

Returns:

this builder

withDefaultLogLevel

public FormattedLogProvider.Builder withDefaultLogLevel(Level level)

Use the specified log Level for all Logs by default.

Parameters:

level - the log level to use as a default

Returns:

this builder

withLogLevel

public FormattedLogProvider.Builder withLogLevel(String context,
                                                 Level level)

Use the specified log Level for any Logs that match the specified context. Any Log context that starts with the specified string will have its level set. For example, setting the level for the context org.neo4j would result in that level being applied to Logs with the context org.neo4j.Foo, org.neo4j.foo.Bar, etc.

Parameters:

context - the context of the Logs to set the level of, matching any Log context starting with this string

level - the log level to apply

Returns:

this builder

withLogLevels

public FormattedLogProvider.Builder withLogLevels(Map<String,Level> levels)

Set the log level for many contexts - equivalent to calling withLogLevel(String, Level) for every entry in the provided map.

Parameters:

levels - a map containing paris of context and level

Returns:

this builder

withoutAutoFlush

public FormattedLogProvider.Builder withoutAutoFlush()

Disable auto flushing.

Returns:

this builder

toOutputStream

public 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 FormattedLogProvider toOutputStream(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 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 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 FormattedLogProvider toPrintWriter(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