FormattedLog (Neo4j - Logging 3.0.7 API)

java.lang.Object
- org.neo4j.logging.AbstractLog
- - org.neo4j.logging.FormattedLog

All Implemented Interfaces:

Log
```
public class FormattedLog
extends AbstractLog
```
A Log implementation that applies a simple formatting to each log message.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FormattedLog.Builder
A Builder for a FormattedLog

Nested Classes
Modifier and Type	Class and Description
`static class`	`FormattedLog.Builder` A Builder for a `FormattedLog`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`bulk(Consumer<Log> consumer)` Used to temporarily log several messages in bulk.
`Logger`	`debugLogger()`
`Logger`	`errorLogger()`
`Level`	`getLevel()` Get the current `Level` that logging is enabled at
`Logger`	`infoLogger()`
`boolean`	`isDebugEnabled()`
`boolean`	`isErrorEnabled()`
`boolean`	`isInfoEnabled()`
`boolean`	`isWarnEnabled()`
`Level`	`setLevel(Level level)` Set the `Level` that logging should be enabled at
`static FormattedLog`	`toOutputStream(OutputStream out)` Creates a `FormattedLog` instance that writes messages to an `OutputStream`.
`static FormattedLog`	`toOutputStream(Supplier<OutputStream> outSupplier)` Creates a `FormattedLog` instance that writes messages to `OutputStream`s obtained from the specified `Supplier`.
`static FormattedLog`	`toPrintWriter(PrintWriter writer)` Creates a `FormattedLog` instance that writes messages to a `PrintWriter`.
`static FormattedLog`	`toPrintWriter(Supplier<PrintWriter> writerSupplier)` Creates a `FormattedLog` instance that writes messages to `PrintWriter`s obtained from the specified `Supplier`.
`static FormattedLog`	`toWriter(Writer writer)` Creates a `FormattedLog` instance that writes messages to a `Writer`.
`static FormattedLog.Builder`	`usingLock(Object lock)` Start creating a `FormattedLog` using the specified object to synchronize on.
`Logger`	`warnLogger()`
`static FormattedLog.Builder`	`withCategory(String category)` Include the specified category in each output log line
`static FormattedLog.Builder`	`withLogLevel(Level level)` Start creating a `FormattedLog` with the specified log `Level` as a default.
`static FormattedLog.Builder`	`withoutAutoFlush()` Start creating a `FormattedLog` without auto flushing.
`static FormattedLog.Builder`	`withTimeZone(TimeZone timezone)` Start creating a `FormattedLog` with the specified timezone for datestamps in the log
`static FormattedLog.Builder`	`withUTCTimeZone()` Start creating a `FormattedLog` with UTC timezone for datestamps in the log

Methods inherited from class org.neo4j.logging.AbstractLog
debug, debug, debug, error, error, error, info, info, info, warn, warn, warn

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - withUTCTimeZone
```
public static FormattedLog.Builder withUTCTimeZone()
```
    Start creating a FormattedLog with UTC timezone for datestamps in the log
    
    Returns:
    
    a builder for a FormattedLog
  - withTimeZone
```
public static FormattedLog.Builder withTimeZone(TimeZone timezone)
```
    Start creating a FormattedLog with the specified timezone for datestamps in the log
    
    Parameters:
    
    timezone - the timezone to use for datestamps
    
    Returns:
    
    a builder for a FormattedLog
  - usingLock
```
public static FormattedLog.Builder usingLock(Object lock)
```
    Start creating a FormattedLog using the specified object to synchronize on. Use FormattedLog.Builder.toOutputStream(java.io.OutputStream) to complete.
    
    Parameters:
    
    lock - the object to synchronize on
    
    Returns:
    
    a builder for a FormattedLog
  - withCategory
```
public static 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:
    
    a builder for a FormattedLog
  - withLogLevel
```
public static FormattedLog.Builder withLogLevel(Level level)
```
    Start creating a FormattedLog with the specified log Level as a default. Use FormattedLog.Builder.toOutputStream(java.io.OutputStream) to complete.
    
    Parameters:
    
    level - the log level to use as a default
    
    Returns:
    
    a builder for a FormattedLog
  - withoutAutoFlush
```
public static FormattedLog.Builder withoutAutoFlush()
```
    Start creating a FormattedLog without auto flushing. Use FormattedLog.Builder.toOutputStream(java.io.OutputStream) to complete.
    
    Returns:
    
    a builder for a FormattedLog
  - toOutputStream
```
public static 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 static 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 static 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 static 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 static 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
  - getLevel
```
public Level getLevel()
```
    Get the current Level that logging is enabled at
    
    Returns:
    
    the current level that logging is enabled at
  - setLevel
```
public Level setLevel(Level level)
```
    Set the Level that logging should be enabled at
    
    Parameters:
    
    level - the new logging level
    
    Returns:
    
    the previous logging level
  - isDebugEnabled
```
public boolean isDebugEnabled()
```
    Returns:
    
    true if the current log level enables debug logging
  - debugLogger
```
@Nonnull
public Logger debugLogger()
```
    Returns:
    
    a Logger instance for writing debug messages
  - isInfoEnabled
```
public boolean isInfoEnabled()
```
    Returns:
    
    true if the current log level enables info logging
  - infoLogger
```
@Nonnull
public Logger infoLogger()
```
    Returns:
    
    a Logger instance for writing info messages
  - isWarnEnabled
```
public boolean isWarnEnabled()
```
    Returns:
    
    true if the current log level enables warn logging
  - warnLogger
```
@Nonnull
public Logger warnLogger()
```
    Returns:
    
    a Logger instance for writing warn messages
  - isErrorEnabled
```
public boolean isErrorEnabled()
```
    Returns:
    
    true if the current log level enables error logging
  - errorLogger
```
@Nonnull
public Logger errorLogger()
```
    Returns:
    
    a Logger instance for writing error messages
  - bulk
```
public void bulk(@Nonnull
                 Consumer<Log> consumer)
```
    Description copied from interface: Log
    
    Used to temporarily log several messages in bulk. The implementation may choose to disable flushing, and may also block other operations until the bulk update is completed.
    
    Parameters:
    
    consumer - A consumer for the bulk Log

Class FormattedLog

Nested Class Summary

Method Summary

Methods inherited from class org.neo4j.logging.AbstractLog

Methods inherited from class java.lang.Object

Method Detail

withUTCTimeZone

withTimeZone

usingLock

withCategory

withLogLevel

withoutAutoFlush

toOutputStream

toOutputStream

toWriter

toPrintWriter

toPrintWriter

getLevel

setLevel

isDebugEnabled

debugLogger

isInfoEnabled

infoLogger

isWarnEnabled

warnLogger

isErrorEnabled

errorLogger

bulk