FileLogger Leave feedback
On this page
Inheritance: java.lang.Object
All Implemented Interfaces: com.groupdocs.foundation.logging.ILogger
public class FileLogger implements 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));
| Constructor | 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 | Description |
|---|---|
| trace(String message, Object[] arguments) | Writes a trace message to the file. |
| trace(Throwable throwable, String message, Object[] arguments) | Writes a trace message to the file. |
| isTraceEnabled() | Checks whether trace logging enabled. |
| debug(String message, Object[] arguments) | Writes a debug message to the file. |
| debug(Throwable throwable, String message, Object[] arguments) | Writes a debug message to the file. |
| isDebugEnabled() | Checks whether debug logging enabled. |
| warning(String message, Object[] arguments) | Writes a warning message to the file. |
| warning(Throwable throwable, String message, Object[] arguments) | Writes a warning message to the file. |
| isWarningEnabled() | Checks whether warning logging enabled. |
| error(String message, Object[] arguments) | Writes an error message to the file. |
| error(Throwable throwable, String message, Object[] arguments) | Writes an error message to the file. |
| isErrorEnabled() | Checks whether error logging enabled. |
public FileLogger(String filePath)
Initializes a new instance of the FileLogger class with file path.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| filePath | java.lang.String | The path to the file that will be used to write logs |
FileLogger(String filePath, boolean isTraceEnabled, boolean isDebugEnabled, boolean isWarningEnabled, boolean isErrorEnabled)
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:
| Parameter | Type | Description |
|---|---|---|
| filePath | java.lang.String | The path to the file that will be used to write logs |
| isTraceEnabled | boolean | True to enable trace logging, false otherwise |
| isDebugEnabled | boolean | True to enable debug logging, false otherwise |
| isWarningEnabled | boolean | True to enable warning logging, false otherwise |
| isErrorEnabled | boolean | True to enable error logging, false otherwise |
public static final String MESSAGE
public static final String EXCEPTION
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| message | java.lang.String | The message. |
| arguments | java.lang.Object[] | The arguments, replaces {} in message in order of passing, null will be written as ’null' |
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| throwable | java.lang.Throwable | The throwable object that will be used to get the stacktrace |
| message | java.lang.String | The message. |
| arguments | java.lang.Object[] | The arguments, replaces {} in message in order of passing, null will be written as ’null' |
public boolean isTraceEnabled()
Checks whether trace logging enabled.
Returns: boolean - true if enabled, otherwise false
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| message | java.lang.String | The message. |
| arguments | java.lang.Object[] | The arguments, replaces {} in message in order of passing, null will be written as ’null' |
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| throwable | java.lang.Throwable | The throwable object that will be used to get the stacktrace |
| message | java.lang.String | The message. |
| arguments | java.lang.Object[] | The arguments, replaces {} in message in order of passing, null will be written as ’null' |
public boolean isDebugEnabled()
Checks whether debug logging enabled.
Returns: boolean - true if enabled, otherwise false
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| message | java.lang.String | The message. |
| arguments | java.lang.Object[] | The arguments, replaces {} in message in order of passing, null will be written as ’null' |
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| throwable | java.lang.Throwable | The throwable object that will be used to get the stacktrace |
| message | java.lang.String | The message. |
| arguments | java.lang.Object[] | The arguments, replaces {} in message in order of passing, null will be written as ’null' |
public boolean isWarningEnabled()
Checks whether warning logging enabled.
Returns: boolean - true if enabled, otherwise false
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| message | java.lang.String | The message. |
| arguments | java.lang.Object[] | The arguments, replaces {} in message in order of passing, null will be written as ’null' |
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| throwable | java.lang.Throwable | The throwable object that will be used to get the stacktrace |
| message | java.lang.String | The message. |
| arguments | java.lang.Object[] | The arguments, replaces {} in message in order of passing, null will be written as ’null' |
public boolean isErrorEnabled()
Checks whether error logging enabled.
Returns: boolean - true if enabled, otherwise false
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
