org.neo4j.logging

Interface Log

All Known Implementing Classes:

AbstractLog, AsyncLog, BufferingLog, DuplicatingLog, FormattedLog, NullLog

public interface Log

A log into which various levels of messages can be written

Method Summary

Modifier and Type	Method and Description
void	bulk(Consumer<Log> consumer) Used to temporarily log several messages in bulk.
void	debug(String message) Shorthand for debugLogger().log( message )
void	debug(String format, Object... arguments) Shorthand for debugLogger().log( format, arguments )
void	debug(String message, Throwable throwable) Shorthand for debugLogger().log( message, throwable )
Logger	debugLogger()
void	error(String message) Shorthand for errorLogger().log( message )
void	error(String format, Object... arguments) Shorthand for errorLogger().log( format, arguments )
void	error(String message, Throwable throwable) Shorthand for errorLogger().log( message, throwable )
Logger	errorLogger()
void	info(String message) Shorthand for infoLogger().log( message )
void	info(String format, Object... arguments) Shorthand for infoLogger().log( format, arguments )
void	info(String message, Throwable throwable) Shorthand for infoLogger().log( message, throwable )
Logger	infoLogger()
boolean	isDebugEnabled()
void	warn(String message) Shorthand for warnLogger().log( message )
void	warn(String format, Object... arguments) Shorthand for warnLogger().log( format, arguments )
void	warn(String message, Throwable throwable) Shorthand for warnLogger().log( message, throwable )
Logger	warnLogger()

Method Detail

isDebugEnabled

boolean isDebugEnabled()

Returns:

true if the current log level enables debug logging

debugLogger

@Nonnull
Logger debugLogger()

Returns:

a Logger instance for writing debug messages

debug

void debug(@Nonnull
           String message)

Shorthand for debugLogger().log( message )

Parameters:

message - The message to be written

debug

void debug(@Nonnull
           String message,
           @Nonnull
           Throwable throwable)

Shorthand for debugLogger().log( message, throwable )

Parameters:

message - The message to be written

throwable - An exception that will also be written

debug

void debug(@Nonnull
           String format,
           @Nonnull
           Object... arguments)

Shorthand for debugLogger().log( format, arguments )

Parameters:

format - A string format for writing a message

arguments - Arguments to substitute into the message according to the format

infoLogger

@Nonnull
Logger infoLogger()

Returns:

a Logger instance for writing info messages

info

void info(@Nonnull
          String message)

Shorthand for infoLogger().log( message )

Parameters:

message - The message to be written

info

void info(@Nonnull
          String message,
          @Nonnull
          Throwable throwable)

Shorthand for infoLogger().log( message, throwable )

Parameters:

message - The message to be written

throwable - An exception that will also be written

info

void info(@Nonnull
          String format,
          @Nonnull
          Object... arguments)

Shorthand for infoLogger().log( format, arguments )

Parameters:

format - A string format for writing a message

arguments - Arguments to substitute into the message according to the format

warnLogger

@Nonnull
Logger warnLogger()

Returns:

a Logger instance for writing warn messages

warn

void warn(@Nonnull
          String message)

Shorthand for warnLogger().log( message )

Parameters:

message - The message to be written

warn

void warn(@Nonnull
          String message,
          @Nonnull
          Throwable throwable)

Shorthand for warnLogger().log( message, throwable )

Parameters:

message - The message to be written

throwable - An exception that will also be written

warn

void warn(@Nonnull
          String format,
          @Nonnull
          Object... arguments)

Shorthand for warnLogger().log( format, arguments )

Parameters:

format - A string format for writing a message

arguments - Arguments to substitute into the message according to the format

errorLogger

@Nonnull
Logger errorLogger()

Returns:

a Logger instance for writing error messages

error

void error(@Nonnull
           String message)

Shorthand for errorLogger().log( message )

Parameters:

message - The message to be written

error

void error(@Nonnull
           String message,
           @Nonnull
           Throwable throwable)

Shorthand for errorLogger().log( message, throwable )

Parameters:

message - The message to be written

throwable - An exception that will also be written

error

void error(@Nonnull
           String format,
           @Nonnull
           Object... arguments)

Shorthand for errorLogger().log( format, arguments )

Parameters:

format - A string format for writing a message

arguments - Arguments to substitute into the message according to the format

bulk

void bulk(@Nonnull
          Consumer<Log> consumer)

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