com.groupdocs.comparison.logging

Class ComparisonLogger

java.lang.Object

com.groupdocs.comparison.logging.ComparisonLogger

public class ComparisonLogger
extends Object

Implements logging methods and a way to configure integrated or set user defined logger.

The class allows setting up integrated or custom logger and writing log messages.

Example usage:

 ComparisonLogger.setLogger(new com.groupdocs.comparison.logging.ConsoleLogger(false, true, true, true));
 ComparisonLogger.warning(exceptionObject, "Warning message with parameters: {}, {}", "parameter1", 2);
 

See Also:

com.groupdocs.comparison.logging.ConsoleLogger, com.groupdocs.comparison.logging.NullLogger

Method Summary

Modifier and Type	Method and Description
static void	debug(String message, Object... arguments) Writes debug message to pre-configured logger.
static void	debug(Throwable throwable, String message, Object... arguments) Writes debug message, stacktrace and message from an exception to pre-configured logger.
static void	error(String message, Object... arguments) Writes error message to pre-configured logger.
static void	error(Throwable throwable, String message, Object... arguments) Writes error message, stacktrace and message from an exception to pre-configured logger.
static com.groupdocs.foundation.logging.ILogger	getLogger() Gets pre-configured logger that will be used to write all types of logs.
static boolean	isDebugEnabled() Checks whether debug logging enabled in pre-configured logger.
static boolean	isErrorEnabled() Checks whether error logging enabled in pre-configured logger.
static boolean	isTraceEnabled() Checks whether trace logging enabled in pre-configured logger.
static boolean	isWarningEnabled() Checks whether warning logging enabled in pre-configured logger.
static void	setLogger(com.groupdocs.foundation.logging.ILogger logger) Sets the logger that will be used to write all types of logs.
static void	trace(String message, Object... arguments) Writes trace message to pre-configured logger.
static void	trace(Throwable throwable, String message, Object... arguments) Writes trace message, stacktrace and message from an exception to pre-configured logger.
static void	warning(String message, Object... arguments) Writes warning message to pre-configured logger.
static void	warning(Throwable throwable, String message, Object... arguments) Writes warning message, stacktrace and message from an exception to pre-configured logger.

Methods inherited from class java.lang.Object

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

Method Detail

debug

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

Writes debug message to pre-configured logger.

Parameters:

message - The message, if null behaviour depends on logger

arguments - The arguments to be embedded into message, if null behaviour depends on logger

debug

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

Writes debug message, stacktrace and message from an exception to pre-configured logger.

Parameters:

throwable - The throwable object that will be used to get the stacktrace, if null behaviour depends on logger

message - The message, if null behaviour depends on logger

arguments - The arguments to be embedded into message, if null behaviour depends on logger

error

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

Writes error message to pre-configured logger.

Parameters:

message - The message, if null behaviour depends on logger

arguments - The arguments to be embedded into message, if null behaviour depends on logger

error

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

Writes error message, stacktrace and message from an exception to pre-configured logger.

Parameters:

throwable - The throwable object that will be used to get the stacktrace, if null behaviour depends on logger

message - The message, if null behaviour depends on logger

arguments - The arguments to be embedded into message, if null behaviour depends on logger

getLogger

public static com.groupdocs.foundation.logging.ILogger getLogger()

Gets pre-configured logger that will be used to write all types of logs.

Returns:

the logger

isDebugEnabled

public static boolean isDebugEnabled()

Checks whether debug logging enabled in pre-configured logger.

Returns:

true if enabled in pre-configured logger, otherwise false

isErrorEnabled

public static boolean isErrorEnabled()

Checks whether error logging enabled in pre-configured logger.

Returns:

true if enabled in pre-configured logger, otherwise false

isTraceEnabled

public static boolean isTraceEnabled()

Checks whether trace logging enabled in pre-configured logger.

Returns:

true if enabled in pre-configured logger, otherwise false

isWarningEnabled

public static boolean isWarningEnabled()

Checks whether warning logging enabled in pre-configured logger.

Returns:

true if enabled in pre-configured logger, otherwise false

setLogger

public static void setLogger(com.groupdocs.foundation.logging.ILogger logger)

Sets the logger that will be used to write all types of logs.

Parameters:

logger - The logger

Throws:

IllegalArgumentException - if logger is null

trace

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

Writes trace message to pre-configured logger.

Parameters:

message - The message, if null behaviour depends on logger

arguments - The arguments to be embedded into message, if null behaviour depends on logger

trace

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

Writes trace message, stacktrace and message from an exception to pre-configured logger.

Parameters:

throwable - The throwable object that will be used to get the stacktrace, if null behaviour depends on logger

message - The message, if null behaviour depends on logger

arguments - The arguments to be embedded into message, if null behaviour depends on logger

warning

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

Writes warning message to pre-configured logger.

Parameters:

message - The message, if null behaviour depends on logger

arguments - The arguments to be embedded into message, if null behaviour depends on logger

warning

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

Writes warning message, stacktrace and message from an exception to pre-configured logger.

Parameters:

throwable - The throwable object that will be used to get the stacktrace, if null behaviour depends on logger

message - The message, if null behaviour depends on logger

arguments - The arguments to be embedded into message, if null behaviour depends on logger