com.groupdocs.comparison.logging

Class FileLogger

java.lang.Object

com.groupdocs.comparison.logging.FileLogger

All Implemented Interfaces:

com.groupdocs.foundation.logging.ILogger

public class FileLogger
extends Object
implements com.groupdocs.foundation.logging.ILogger

Logger that writes logs to file.

Should be used together with ComparisonLogger.

Example usage:

 ComparisonLogger.setLogger(new FileLogger("/path/to/file.log.txt", false, true, true, true));
 

See Also:

ComparisonLogger

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXCEPTION
static String	MESSAGE

Constructor Summary

Constructors

Constructor and Description
FileLogger(String filePath) Initializes a new instance of the FileLogger class with file path.
FileLogger(String filePath, boolean isTraceEnabled, boolean isDebugEnabled, boolean isWarningEnabled, boolean isErrorEnabled) Initializes a new instance of the FileLogger class with file path and logs levels configuration.

Method Summary

Modifier and Type	Method and Description
void	debug(String message, Object... arguments) Writes a debug message to the file.
void	debug(Throwable throwable, String message, Object... arguments) Writes a debug message to the file.
void	error(String message, Object... arguments) Writes an error message to the file.
void	error(Throwable throwable, String message, Object... arguments) Writes an error message to the file.
boolean	isDebugEnabled() Checks whether debug logging enabled.
boolean	isErrorEnabled() Checks whether error logging enabled.
boolean	isTraceEnabled() Checks whether trace logging enabled.
boolean	isWarningEnabled() Checks whether warning logging enabled.
void	trace(String message, Object... arguments) Writes a trace message to the file.
void	trace(Throwable throwable, String message, Object... arguments) Writes a trace message to the file.
void	warning(String message, Object... arguments) Writes a warning message to the file.
void	warning(Throwable throwable, String message, Object... arguments) Writes a warning message to the file.

Methods inherited from class java.lang.Object

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

Field Detail

EXCEPTION

public static final String EXCEPTION

See Also:

Constant Field Values

MESSAGE

public static final String MESSAGE

See Also:

Constant Field Values

Constructor Detail

FileLogger

public FileLogger(String filePath)

Initializes a new instance of the FileLogger class with file path.

Parameters:

filePath - The path to the file that will be used to write logs

FileLogger

public FileLogger(String filePath,
                  boolean isTraceEnabled,
                  boolean isDebugEnabled,
                  boolean isWarningEnabled,
                  boolean isErrorEnabled)

Initializes a new instance of the FileLogger class with file path and logs levels configuration.

Parameters:

filePath - The path to the file that will be used to write logs

isTraceEnabled - True to enable trace logging, false otherwise

isDebugEnabled - True to enable debug logging, false otherwise

isWarningEnabled - True to enable warning logging, false otherwise

isErrorEnabled - True to enable error logging, false otherwise

Method Detail

debug

public void debug(String message,
                  Object... arguments)

Writes a debug message to the file.

Debug log messages provide information about different processes in application flow. The message can contain one or few {} which will be replaced by corresponding arguments.

Specified by:

debug in interface com.groupdocs.foundation.logging.ILogger

Parameters:

message - The message.

arguments - The arguments, replaces {} in message in order of passing, null will be written as 'null'

Throws:

IllegalArgumentException - if message is null

debug

public void debug(Throwable throwable,
                  String message,
                  Object... arguments)

Writes a debug message to the file.

Debug log messages provide information about different processes in application flow. The message can contain one or few {} which will be replaced by corresponding arguments.

Specified by:

debug in interface com.groupdocs.foundation.logging.ILogger

Parameters:

throwable - The throwable object that will be used to get the stacktrace

message - The message.

arguments - The arguments, replaces {} in message in order of passing, null will be written as 'null'

Throws:

IllegalArgumentException - if throwable is null

IllegalArgumentException - if message is null

error

public void error(String message,
                  Object... arguments)

Writes an error message to the file.

Error log messages provide information about unrecoverable events in application flow. The message can contain one or few {} which will be replaced by corresponding arguments.

Specified by:

error in interface com.groupdocs.foundation.logging.ILogger

Parameters:

message - The message.

arguments - The arguments, replaces {} in message in order of passing, null will be written as 'null'

Throws:

IllegalArgumentException - if message is null

error

public void error(Throwable throwable,
                  String message,
                  Object... arguments)

Writes an error message to the file.

Error log messages provide information about unrecoverable events in application flow. The message can contain one or few {} which will be replaced by corresponding arguments.

Specified by:

error in interface com.groupdocs.foundation.logging.ILogger

Parameters:

throwable - The throwable object that will be used to get the stacktrace

message - The message.

arguments - The arguments, replaces {} in message in order of passing, null will be written as 'null'

Throws:

IllegalArgumentException - if throwable is null

IllegalArgumentException - if message is null

isDebugEnabled

public boolean isDebugEnabled()

Checks whether debug logging enabled.

Specified by:

isDebugEnabled in interface com.groupdocs.foundation.logging.ILogger

Returns:

true if enabled, otherwise false

isErrorEnabled

public boolean isErrorEnabled()

Checks whether error logging enabled.

Specified by:

isErrorEnabled in interface com.groupdocs.foundation.logging.ILogger

Returns:

true if enabled, otherwise false

isTraceEnabled

public boolean isTraceEnabled()

Checks whether trace logging enabled.

Specified by:

isTraceEnabled in interface com.groupdocs.foundation.logging.ILogger

Returns:

true if enabled, otherwise false

isWarningEnabled

public boolean isWarningEnabled()

Checks whether warning logging enabled.

Specified by:

isWarningEnabled in interface com.groupdocs.foundation.logging.ILogger

Returns:

true if enabled, otherwise false

trace

public void trace(String message,
                  Object... arguments)

Writes a trace message to the file.

Trace log messages provide maximum detailed information about application flow. The message can contain one or few {} which will be replaced by corresponding arguments.

Specified by:

trace in interface com.groupdocs.foundation.logging.ILogger

Parameters:

message - The message.

arguments - The arguments, replaces {} in message in order of passing, null will be written as 'null'

Throws:

IllegalArgumentException - if message is null

trace

public void trace(Throwable throwable,
                  String message,
                  Object... arguments)

Writes a trace message to the file.

Trace log messages provide maximum detailed information about application flow. The message can contain one or few {} which will be replaced by corresponding arguments.

Specified by:

trace in interface com.groupdocs.foundation.logging.ILogger

Parameters:

throwable - The throwable object that will be used to get the stacktrace

message - The message.

arguments - The arguments, replaces {} in message in order of passing, null will be written as 'null'

Throws:

IllegalArgumentException - if throwable is null

IllegalArgumentException - if message is null

warning

public void warning(String message,
                    Object... arguments)

Writes a warning message to the file.

Warning log messages provide information about unexpected and recoverable events in application flow. The message can contain one or few {} which will be replaced by corresponding arguments.

Specified by:

warning in interface com.groupdocs.foundation.logging.ILogger

Parameters:

message - The message.

arguments - The arguments, replaces {} in message in order of passing, null will be written as 'null'

Throws:

IllegalArgumentException - if message is null

warning

public void warning(Throwable throwable,
                    String message,
                    Object... arguments)

Writes a warning message to the file.

Warning log messages provide information about unexpected and recoverable events in application flow. The message can contain one or few {} which will be replaced by corresponding arguments.

Specified by:

warning in interface com.groupdocs.foundation.logging.ILogger

Parameters:

throwable - The throwable object that will be used to get the stacktrace

message - The message.

arguments - The arguments, replaces {} in message in order of passing, null will be written as 'null'

Throws:

IllegalArgumentException - if throwable is null

IllegalArgumentException - if message is null