org.neo4j.logging

Class FormattedLog.Builder

java.lang.Object

org.neo4j.logging.FormattedLog.Builder

Enclosing class:

FormattedLog

public static class FormattedLog.Builder
extends Object

A Builder for a FormattedLog

Method Summary

Modifier and Type	Method and Description
FormattedLog	toOutputStream(OutputStream out) Creates a FormattedLog instance that writes messages to an OutputStream.
FormattedLog	toOutputStream(Supplier<OutputStream> outSupplier) Creates a FormattedLog instance that writes messages to OutputStreams obtained from the specified Supplier.
FormattedLog	toPrintWriter(PrintWriter writer) Creates a FormattedLog instance that writes messages to a PrintWriter.
FormattedLog	toPrintWriter(Supplier<PrintWriter> writerSupplier) Creates a FormattedLog instance that writes messages to PrintWriters obtained from the specified Supplier.
FormattedLog	toWriter(Writer writer) Creates a FormattedLog instance that writes messages to a Writer.
FormattedLog.Builder	usingLock(Object lock) Use the specified object to synchronize on.
FormattedLog.Builder	withCategory(String category) Include the specified category in each output log line.
FormattedLog.Builder	withLogLevel(Level level) Use the specified log Level as a default.
FormattedLog.Builder	withoutAutoFlush() Disable auto flushing.
FormattedLog.Builder	withTimeZone(TimeZone timezone) Set the timezone for datestamps in the log
FormattedLog.Builder	withUTCTimeZone() Set the timezone for datestamps in the log

Methods inherited from class java.lang.Object

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

Method Detail

withUTCTimeZone

public FormattedLog.Builder withUTCTimeZone()

Set the timezone for datestamps in the log

Returns:

this builder

withTimeZone

public FormattedLog.Builder withTimeZone(TimeZone timezone)

Set the timezone for datestamps in the log

Parameters:

timezone - the timezone to use for datestamps

Returns:

this builder

usingLock

public FormattedLog.Builder usingLock(Object lock)

Use the specified object to synchronize on.

Parameters:

lock - the object to synchronize on

Returns:

this builder

withCategory

public FormattedLog.Builder withCategory(String category)

Include the specified category in each output log line.

Parameters:

category - the category to include ing each output line

Returns:

this builder

withLogLevel

public FormattedLog.Builder withLogLevel(Level level)

Use the specified log Level as a default.

Parameters:

level - the log level to use as a default

Returns:

this builder

withoutAutoFlush

public FormattedLog.Builder withoutAutoFlush()

Disable auto flushing.

Returns:

this builder

toOutputStream

public FormattedLog toOutputStream(OutputStream out)

Creates a FormattedLog instance that writes messages to an OutputStream.

Parameters:

out - An OutputStream to write to

Returns:

A FormattedLog instance that writes to the specified OutputStream

toOutputStream

public FormattedLog toOutputStream(Supplier<OutputStream> outSupplier)

Creates a FormattedLog 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 FormattedLog instance

toWriter

public FormattedLog toWriter(Writer writer)

Creates a FormattedLog instance that writes messages to a Writer.

Parameters:

writer - A Writer to write to

Returns:

A FormattedLog instance that writes to the specified Writer

toPrintWriter

public FormattedLog toPrintWriter(PrintWriter writer)

Creates a FormattedLog instance that writes messages to a PrintWriter.

Parameters:

writer - A PrintWriter to write to

Returns:

A FormattedLog instance that writes to the specified PrintWriter

toPrintWriter

public FormattedLog toPrintWriter(Supplier<PrintWriter> writerSupplier)

Creates a FormattedLog 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 FormattedLog instance that writes to the specified PrintWriter