Package 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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Logger.TEMPLATE

Method Summary

Modifier and Type	Method	Description
static boolean	createNewTemplate(Enum<?> templateName, String colorCode, String logLevel)
static boolean	createNewTemplate(Enum<?> templateName, String colorCode, String logLevel, boolean writeToFile)
static boolean	createNewTemplate(Enum<?> templateName, String colorCode, String logLevel, boolean writeToFile, boolean onlyVerbose, boolean onlyDebug)
static boolean	createNewTemplate(Enum<?> templateName, String colorCode, String logLevel, boolean writeToFile, boolean onlyVerbose, boolean onlyDebug, boolean hidePrefix)
static boolean	createNewTemplate(Enum<?> templateName, String colorCode, String logLevel, boolean writeToFile, boolean onlyVerbose, boolean onlyDebug, boolean hidePrefix, boolean mixpanelMessage)
static boolean	createNewTemplate(Enum<?> templateName, String colorCode, String logLevel, boolean writeToFile, boolean onlyVerbose, boolean onlyDebug, boolean hidePrefix, boolean mixpanelMessage, String mixpanelName)
static boolean	createNewTemplate(Enum<?> templateName, String colorCode, String backgroundColorCode, String logLevel, boolean writeToFile, boolean onlyVerbose, boolean onlyDebug, boolean hidePrefix, boolean exceptionsInConsole, boolean mixpanelMessage, String mixpanelName)
static boolean	createNewTemplate(Enum<?> templateName, String colorCode, String backgroundColorCode, String logLevel, boolean writeToFile, boolean onlyVerbose, boolean onlyDebug, boolean hidePrefix, boolean mixpanelMessage, String mixpanelName)
static boolean	createNewTemplate(String templateName, String colorCode, String logLevel)
static boolean	createNewTemplate(String templateName, String colorCode, String logLevel, boolean writeToFile)
static boolean	createNewTemplate(String templateName, String colorCode, String logLevel, boolean writeToFile, boolean onlyVerbose, boolean onlyDebug)
static boolean	createNewTemplate(String templateName, String colorCode, String logLevel, boolean writeToFile, boolean onlyVerbose, boolean onlyDebug, boolean hidePrefix)
static boolean	createNewTemplate(String templateName, String colorCode, String logLevel, boolean writeToFile, boolean onlyVerbose, boolean onlyDebug, boolean hidePrefix, boolean mixpanelMessage)
static boolean	createNewTemplate(String templateName, String colorCode, String logLevel, boolean writeToFile, boolean onlyVerbose, boolean onlyDebug, boolean hidePrefix, boolean mixpanelMessage, String mixpanelName)
static boolean	createNewTemplate(String templateName, String colorCode, String backgroundColorCode, String logLevel, boolean writeToFile, boolean onlyVerbose, boolean onlyDebug, boolean hidePrefix, boolean exceptionsInConsole, boolean mixpanelMessage, String mixpanelName)	Create a new LogTemplate for logging that can be used to quickly create a new LogEntry.
static boolean	createNewTemplate(String templateName, String colorCode, String backgroundColorCode, String logLevel, boolean writeToFile, boolean onlyVerbose, boolean onlyDebug, boolean hidePrefix, boolean mixpanelMessage, String mixpanelName)
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, Enum<?> template)
static boolean	log(String text, Enum<?> templateName, Exception e)
static boolean	log(String text, Enum<?> templateName, Exception e, int errorCode)
static boolean	log(String text, String templateName)
static boolean	log(String text, String templateName, Exception e)
static boolean	log(String text, String templateName, Exception e, int errorCode)	Create a LogEntry with the specified text and LogTemplate.
void	setConsoleExceptions(boolean showExceptionsInConsole)	Change the way Exceptions are displayed in the console.
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.

Methods inherited from class java.lang.Object

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

Method Details

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).

setConsoleExceptions

public void setConsoleExceptions(boolean showExceptionsInConsole)

Change the way Exceptions are displayed in the console. Using console-exceptions will print out all StackTraces of exceptions in your console. This has the same effect as the consoleException setting in a single LogEntry, but will affect all logging.

Parameters:

showExceptionsInConsole - Weather or not the Logger should print StackTraces in the console (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,
 Exception e,
 int errorCode)

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.

e - The exception that should get logged (Default is null).

errorCode - The code for the error that occured (Default is 0).

Returns:

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

log

public static boolean log(String text,
 Enum<?> templateName,
 Exception e,
 int errorCode)

See Also:

• log(String, String, Exception, int)

log

public static boolean log(String text,
 String templateName,
 Exception e)

See Also:

• log(String, String, Exception, int)

log

public static boolean log(String text,
 Enum<?> templateName,
 Exception e)

See Also:

• log(String, String, Exception, int)

log

public static boolean log(String text,
 String templateName)

See Also:

• log(String, String, Exception, int)

log

public static boolean log(String text,
 Enum<?> template)

See Also:

• log(String, String, Exception, int)

createNewTemplate

public static boolean createNewTemplate(String templateName,
 String colorCode,
 String backgroundColorCode,
 String logLevel,
 boolean writeToFile,
 boolean onlyVerbose,
 boolean onlyDebug,
 boolean hidePrefix,
 boolean exceptionsInConsole,
 boolean mixpanelMessage,
 String mixpanelName)

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.

backgroundColorCode - The background 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.

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

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

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

exceptionsInConsole - If LogEntrys whith these settings should print their exceptions in the console.

mixpanelMessage - If the LogEntry should be sent to Mixpanel.

mixpanelName - The name of the Mixpanel-event.

Returns:

True if the LogTemplate was created successfully, False if the LogTemplate was overwritten.

createNewTemplate

public static boolean createNewTemplate(Enum<?> templateName,
 String colorCode,
 String backgroundColorCode,
 String logLevel,
 boolean writeToFile,
 boolean onlyVerbose,
 boolean onlyDebug,
 boolean hidePrefix,
 boolean exceptionsInConsole,
 boolean mixpanelMessage,
 String mixpanelName)

See Also:

• createNewTemplate(String, String, String, String, boolean, boolean, boolean, boolean, boolean, boolean, String)

createNewTemplate

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

See Also:

• createNewTemplate(String, String, String, String, boolean, boolean, boolean, boolean, boolean, boolean, String)

createNewTemplate

public static boolean createNewTemplate(Enum<?> templateName,
 String colorCode,
 String backgroundColorCode,
 String logLevel,
 boolean writeToFile,
 boolean onlyVerbose,
 boolean onlyDebug,
 boolean hidePrefix,
 boolean mixpanelMessage,
 String mixpanelName)

See Also:

• createNewTemplate(String, String, String, String, boolean, boolean, boolean, boolean, boolean, boolean, String)

createNewTemplate

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

See Also:

• createNewTemplate(String, String, String, String, boolean, boolean, boolean, boolean, boolean, boolean, String)

createNewTemplate

public static boolean createNewTemplate(Enum<?> templateName,
 String colorCode,
 String logLevel,
 boolean writeToFile,
 boolean onlyVerbose,
 boolean onlyDebug,
 boolean hidePrefix,
 boolean mixpanelMessage,
 String mixpanelName)

See Also:

• createNewTemplate(String, String, String, String, boolean, boolean, boolean, boolean, boolean, boolean, String)

createNewTemplate

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

See Also:

• createNewTemplate(String, String, String, String, boolean, boolean, boolean, boolean, boolean, boolean, String)

createNewTemplate

public static boolean createNewTemplate(Enum<?> templateName,
 String colorCode,
 String logLevel,
 boolean writeToFile,
 boolean onlyVerbose,
 boolean onlyDebug,
 boolean hidePrefix,
 boolean mixpanelMessage)

See Also:

• createNewTemplate(String, String, String, String, boolean, boolean, boolean, boolean, boolean, boolean, String)

createNewTemplate

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

See Also:

• createNewTemplate(String, String, String, String, boolean, boolean, boolean, boolean, boolean, boolean, String)

createNewTemplate

public static boolean createNewTemplate(Enum<?> templateName,
 String colorCode,
 String logLevel,
 boolean writeToFile,
 boolean onlyVerbose,
 boolean onlyDebug,
 boolean hidePrefix)

See Also:

• createNewTemplate(String, String, String, String, boolean, boolean, boolean, boolean, boolean, boolean, String)

createNewTemplate

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

See Also:

• createNewTemplate(String, String, String, String, boolean, boolean, boolean, boolean, boolean, boolean, String)

createNewTemplate

public static boolean createNewTemplate(Enum<?> templateName,
 String colorCode,
 String logLevel,
 boolean writeToFile,
 boolean onlyVerbose,
 boolean onlyDebug)

See Also:

• createNewTemplate(String, String, String, String, boolean, boolean, boolean, boolean, boolean, boolean, String)

createNewTemplate

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

See Also:

• createNewTemplate(String, String, String, String, boolean, boolean, boolean, boolean, boolean, boolean, String)

createNewTemplate

public static boolean createNewTemplate(Enum<?> templateName,
 String colorCode,
 String logLevel,
 boolean writeToFile)

See Also:

• createNewTemplate(String, String, String, String, boolean, boolean, boolean, boolean, boolean, boolean, String)

createNewTemplate

public static boolean createNewTemplate(String templateName,
 String colorCode,
 String logLevel)

See Also:

• createNewTemplate(String, String, String, String, boolean, boolean, boolean, boolean, boolean, boolean, String)

createNewTemplate

public static boolean createNewTemplate(Enum<?> templateName,
 String colorCode,
 String logLevel)

See Also:

• createNewTemplate(String, String, String, String, boolean, boolean, boolean, boolean, boolean, boolean, String)