io.fi0x.javalogger.logging

Class Logger

java.lang.Object

io.fi0x.javalogger.logging.Logger

public class Logger
extends Object

This class can be used for logging to the default output and to a log-file.

Field Summary

Fields

Modifier and Type	Field and Description
static String	BLUE
static String	CYAN
static String	GREEN
static String	PURPLE
static String	RED
static String	WHITE
static String	YELLOW

Method Summary

Modifier and Type	Method and Description
static boolean	createNewTemplate(String templateName, String colorCode, String logLevel, boolean writeToFile, boolean onlyVerbose, boolean onlyDebug, boolean hidePrefix) Create a new LogTemplate for logging that can be used to quickly create a new LogEntry.
static Logger	getInstance() Get the Logger-singleton and create it if it does not exist yet.
static void	log(LogEntry log) Print the LogEntry provided with the settings that are stored in the LogEntry.
static boolean	log(String text, String templateName) Create a LogEntry with the specified text and LogTemplate.
void	setDebug(boolean isDebugMode) Change the current debug-mode.
void	setLogFolder(File logFolder) Change the folder where log-files should be stored.
void	setSmallLog(boolean ignorePrefixes) Change the way LogEntrys are displayed.
void	setVerbose(boolean isVerboseMode) Change the current verbose-mode.
static boolean	updateTemplate(String templateName, String colorCode, String logLevel, boolean writeToFile, boolean onlyVerbose, boolean onlyDebug, boolean hidePrefix) Update a specific LogTemplate.

Methods inherited from class java.lang.Object

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

Field Detail

RED

public static final String RED

See Also:

Constant Field Values

GREEN

public static final String GREEN

See Also:

Constant Field Values

YELLOW

public static final String YELLOW

See Also:

Constant Field Values

BLUE

public static final String BLUE

See Also:

Constant Field Values

PURPLE

public static final String PURPLE

See Also:

Constant Field Values

CYAN

public static final String CYAN

See Also:

Constant Field Values

WHITE

public static final String WHITE

See Also:

Constant Field Values

Method Detail

getInstance

public static Logger getInstance()

Get the Logger-singleton and create it if it does not exist yet.

Returns:

The instance of the Logger-singleton.

setLogFolder

public void setLogFolder(File logFolder)

Change the folder where log-files should be stored. If a log-file already exists in the current log-folder, it will be ignored for any future logging and the new log-folder location will be used instead.

Parameters:

logFolder - The path where future log-files should be stored (Default is "PROGRAMDATA/JavaLogger").

setDebug

public void setDebug(boolean isDebugMode)

Change the current debug-mode. LogEntrys whose 'DEBUG' method was set, are only visible if this method is set to true.

Parameters:

isDebugMode - Weather or not the Logger should work in debug-mode (Default is false).

setVerbose

public void setVerbose(boolean isVerboseMode)

Change the current verbose-mode. LogEntrys whose 'VERBOSE' method was set, are only visible if this method is set to true.

Parameters:

isVerboseMode - Weather or not the Logger should work in verbose-mode (Default is false).

setSmallLog

public void setSmallLog(boolean ignorePrefixes)

Change the way LogEntrys are displayed. Using small-logs will remove all prefixes from logging. This has the same effect as the plaintext setting in a single LogEntry, but will affect all logging.

Parameters:

ignorePrefixes - Weather or not the Logger should use small-logs (Default is false).

log

public static void log(LogEntry log)

Print the LogEntry provided with the settings that are stored in the LogEntry. If the LogEntry is set to VERBOSE or DEBUG, it will only be processed if the Logger has activated that mode.

Parameters:

log - The LogEntry that should be processed.

log

public static boolean log(String text,
                          String templateName)

Create a LogEntry with the specified text and LogTemplate.

Parameters:

text - The message to log.

templateName - The name of the LogTemplate that should be used.

Returns:

True if logging was successful, False if the LogTemplate does not exist.

createNewTemplate

public static boolean createNewTemplate(String templateName,
                                        String colorCode,
                                        String logLevel,
                                        boolean writeToFile,
                                        boolean onlyVerbose,
                                        boolean onlyDebug,
                                        boolean hidePrefix)

Create a new LogTemplate for logging that can be used to quickly create a new LogEntry.

Parameters:

templateName - The name which is required to find the LogTemplate again.

colorCode - The color which will be used in the console output.

logLevel - The logging-level.

writeToFile - If LogEntrys written with this LogTemplate should be saved in a log-file.

onlyDebug - If LogEntrys with these settings should only be visible in debug-mode.

onlyVerbose - If LogEntrys with these settings should only be visible in verbose-mode.

hidePrefix - If only the actual message without timestamp, logging-level and error-code should be shown.

Returns:

True if the LogTemplate was created successfully, False if the LogTemplate already existed.

updateTemplate

public static boolean updateTemplate(String templateName,
                                     String colorCode,
                                     String logLevel,
                                     boolean writeToFile,
                                     boolean onlyVerbose,
                                     boolean onlyDebug,
                                     boolean hidePrefix)

Update a specific LogTemplate.

Parameters:

templateName - The name of the LogTemplate.

colorCode - The new color.

logLevel - The new logging-level.

writeToFile - If LogEntrys written with this LogTemplate should be saved in a log-file.

onlyDebug - If LogEntrys with these settings should only be visible in debug-mode.

onlyVerbose - If LogEntrys with these settings should only be visible in verbose-mode.

hidePrefix - If only the actual message without timestamp, logging-level and error-code should be shown.

Returns:

True if the LogTemplate was updated successfully, False if the name was not found.