Package com.storedobject.common

Interface LogWriter

All Known Implementing Classes:

LogWriter.PrintWriterLogWriter

public interface LogWriter

Interface for custom log writers.

Author:

Syam

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	LogWriter.PrintWriterLogWriter	A LogWriter implementation that writes log messages to a PrintWriter.

Method Summary

Modifier and Type	Method	Description
static LogWriter	create()	Creates a new instance of a LogWriter that provides basic logging behavior using standard output streams.
static LogWriter	create(PrintWriter writer)	Creates a new instance of a LogWriter that wraps the given PrintWriter.
static LogWriter	create(Writer writer)	Creates a new instance of a LogWriter that wraps the provided Writer.
static LogWriter	createNull()	Creates a new instance of a LogWriter that performs no operations.
default void	debug(String message)	Writes a debug message.
default void	error(String message)	Writes an error message.
default void	error(String message, Throwable throwable)	Writes an error with stack trace.
default void	flush()	Flushes any buffered output.

Method Details

debug

default void debug(String message)

Writes a debug message.

Parameters:

message - the message to write

error

default void error(String message)

Writes an error message.

Parameters:

message - the error message

error

default void error(String message,
 Throwable throwable)

Writes an error with stack trace.

Parameters:

message - the error message

throwable - the exception

flush

default void flush()

Flushes any buffered output.

create

static LogWriter create()

Creates a new instance of a LogWriter that provides basic logging behavior using standard output streams.

Returns:

a LogWriter instance that writes debug messages to standard output and error messages to standard error.

create

static LogWriter create(PrintWriter writer)

Creates a new instance of a LogWriter that wraps the given PrintWriter. The created LogWriter outputs log messages to the provided PrintWriter.

Parameters:

writer - the PrintWriter to which log messages will be written

Returns:

a LogWriter instance that writes log messages using the given PrintWriter

create

static LogWriter create(Writer writer)

Creates a new instance of a LogWriter that wraps the provided Writer. The created LogWriter outputs log messages to the given Writer.

Parameters:

writer - the Writer to which log messages will be written

Returns:

a LogWriter instance that writes log messages using the provided Writer

createNull

static LogWriter createNull()

Creates a new instance of a LogWriter that performs no operations. This implementation is a no-op and does not produce any output.

Returns:

a LogWriter instance that discards all log messages and performs no actions