lib.easyjava.io.output

Class Logger

java.lang.Object

lib.easyjava.io.output.Logger

public class Logger
extends java.lang.Object

Logs status messages to a file during a program's execution

Author:

Rob Rua (robrua@alumni.cmu.edu)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Logger.Level

Constructor Summary

Constructors

Constructor and Description
Logger() Creates a new console logger with default importance level OUTPUT
Logger(java.io.File file, boolean append) Creates a new logger with default importance level OUTPUT
Logger(java.io.File file, boolean append, Logger.Level level) Creates a new logger
Logger(java.io.File file, boolean append, Logger.Level level, boolean only) Creates a new logger
Logger(Logger.Level level) Creates a new console logger
Logger(Logger.Level level, boolean only) Creates a new console logger
Logger(java.lang.String filePath, boolean append) Creates a new logger with default importance level OUTPUT
Logger(java.lang.String filePath, boolean append, Logger.Level level) Creates a new logger
Logger(java.lang.String filePath, boolean append, Logger.Level level, boolean only) Creates a new logger

Method Summary

Modifier and Type	Method and Description
void	close() Closes the log file
static void	closeDefaultLogger() Closes the default log file.
static void	defaultError(java.lang.Exception exception) Writes an error-level exception to the default log
static void	defaultError(java.lang.String content) Writes an error-level message to the default log
static void	defaultFatal(java.lang.Exception exception) Writes a fatal-level exception to the default log
static void	defaultFatal(java.lang.String content) Writes a fatal-level message to the default log
static void	defaultLog(java.lang.Exception exception, Logger.Level level) Writes the exception to the default log file at the given importance level
static void	defaultLog(java.lang.String content, Logger.Level level) Writes the content to the default log file at the given importance level
static void	defaultOutput(java.lang.Exception exception) Writes an output-level exception to the default log
static void	defaultOutput(java.lang.String content) Writes an output-level message to the default log
static void	defaultVerbose(java.lang.Exception exception) Writes a verbose-level exception to the default log
static void	defaultVerbose(java.lang.String content) Writes a verbose-level message to the default log
static void	defaultWarn(java.lang.Exception exception) Writes a warn-level exception to the default log
static void	defaultWarn(java.lang.String content) Writes a warn-level message to the default log
void	error(java.lang.Exception exception) Writes an error-level exception to the log
void	error(java.lang.String content) Writes an error-level message to the log
void	fatal(java.lang.Exception exception) Writes a fatal-level exception to the log
void	fatal(java.lang.String content) Writes a fatal-level message to the log
void	log(java.lang.Exception exception, Logger.Level level) Writes the exception to the log file at the given importance level
void	log(java.lang.String content, Logger.Level level) Writes the content to the log file at the given importance level
static Logger	nullLogger() Returns the null logger which doesn't log anything
void	output(java.lang.Exception exception) Writes an output-level exception to the log
void	output(java.lang.String content) Writes an output-level message to the log
static void	setDefaultLevel(Logger.Level level, boolean only) Sets the logger level for the default logger.
void	setLevel(Logger.Level level, boolean only) Sets the logger level.
void	verbose(java.lang.Exception exception) Writes a verbose-level exception to the log
void	verbose(java.lang.String content) Writes a verbose-level message to the log
void	warn(java.lang.Exception exception) Writes a warn-level exception to the log
void	warn(java.lang.String content) Writes a warn-level message to the log

Methods inherited from class java.lang.Object

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

Constructor Detail

Logger

public Logger()
       throws java.io.IOException

Creates a new console logger with default importance level OUTPUT

Throws:

java.io.IOException - if an error occurs initializing the logger

Logger

public Logger(java.io.File file,
              boolean append)
       throws java.io.IOException

Creates a new logger with default importance level OUTPUT

Parameters:

file - the file to log to

append - whether to append to the file

Throws:

java.io.IOException - if the file can't be opened

Logger

public Logger(java.io.File file,
              boolean append,
              Logger.Level level)
       throws java.io.IOException

Creates a new logger

Parameters:

file - the file to log to

append - whether to append to the file

level - the minimum importance level to show logs from

Throws:

java.io.IOException - if the file can't be opened

Logger

public Logger(java.io.File file,
              boolean append,
              Logger.Level level,
              boolean only)
       throws java.io.IOException

Creates a new logger

Parameters:

file - the file to log to

append - whether to append to the file

level - the minimum importance level to show logs from

only - whether to show ONLY the logs at the given level or also those above that level

Throws:

java.io.IOException - if the file can't be opened

Logger

public Logger(Logger.Level level)
       throws java.io.IOException

Creates a new console logger

Parameters:

level - the minimum importance level to show logs from

Throws:

java.io.IOException - if an error occurs initializing the logger

Logger

public Logger(Logger.Level level,
              boolean only)
       throws java.io.IOException

Creates a new console logger

Parameters:

level - the minimum importance level to show logs from

only - whether to show ONLY the logs at the given level or also those above that level

Throws:

java.io.IOException - if an error occurs initializing the logger

Logger

public Logger(java.lang.String filePath,
              boolean append)
       throws java.io.IOException

Creates a new logger with default importance level OUTPUT

Parameters:

filePath - the file to log to

append - whether to append to the file

Throws:

java.io.IOException - if the file can't be opened

Logger

public Logger(java.lang.String filePath,
              boolean append,
              Logger.Level level)
       throws java.io.IOException

Creates a new logger

Parameters:

filePath - the file to log to

append - whether to append to the file

level - the minimum importance level to show logs from

Throws:

java.io.IOException - if the file can't be opened

Logger

public Logger(java.lang.String filePath,
              boolean append,
              Logger.Level level,
              boolean only)
       throws java.io.IOException

Creates a new logger

Parameters:

filePath - the file to log to

append - whether to append to the file

level - the minimum importance level to show logs from

only - whether to show ONLY the logs at the given level or also those above that level

Throws:

java.io.IOException - if the file can't be opened

Method Detail

closeDefaultLogger

public static void closeDefaultLogger()

Closes the default log file. The log should be fine if this isn't called, but it's ideal to call it if the default log was ever used

defaultError

public static void defaultError(java.lang.Exception exception)

Writes an error-level exception to the default log

Parameters:

exception - the exception to log

defaultError

public static void defaultError(java.lang.String content)

Writes an error-level message to the default log

Parameters:

content - the message to log

defaultFatal

public static void defaultFatal(java.lang.Exception exception)

Writes a fatal-level exception to the default log

Parameters:

exception - the exception to log

defaultFatal

public static void defaultFatal(java.lang.String content)

Writes a fatal-level message to the default log

Parameters:

content - the message to log

defaultLog

public static void defaultLog(java.lang.Exception exception,
                              Logger.Level level)

Writes the exception to the default log file at the given importance level

Parameters:

exception - the exception to log

level - the importance level of the message

defaultLog

public static void defaultLog(java.lang.String content,
                              Logger.Level level)

Writes the content to the default log file at the given importance level

Parameters:

content - the message to log

level - the importance level of the message

defaultOutput

public static void defaultOutput(java.lang.Exception exception)

Writes an output-level exception to the default log

Parameters:

exception - the exception to log

defaultOutput

public static void defaultOutput(java.lang.String content)

Writes an output-level message to the default log

Parameters:

content - the message to log

defaultVerbose

public static void defaultVerbose(java.lang.Exception exception)

Writes a verbose-level exception to the default log

Parameters:

exception - the exception to log

defaultVerbose

public static void defaultVerbose(java.lang.String content)

Writes a verbose-level message to the default log

Parameters:

content - the message to log

defaultWarn

public static void defaultWarn(java.lang.Exception exception)

Writes a warn-level exception to the default log

Parameters:

exception - the exception to log

defaultWarn

public static void defaultWarn(java.lang.String content)

Writes a warn-level message to the default log

Parameters:

content - the message to log

nullLogger

public static Logger nullLogger()

Returns the null logger which doesn't log anything

Returns:

the null logger

setDefaultLevel

public static void setDefaultLevel(Logger.Level level,
                                   boolean only)

Sets the logger level for the default logger. Logs above the importance of the set level will also be shown if only is set false.

Parameters:

level - the level to set

only - determines whether to only show logs at this level, or to also show logs of higher importance

close

public void close()

Closes the log file

error

public void error(java.lang.Exception exception)

Writes an error-level exception to the log

Parameters:

exception - the exception to log

error

public void error(java.lang.String content)

Writes an error-level message to the log

Parameters:

content - the message to log

fatal

public void fatal(java.lang.Exception exception)

Writes a fatal-level exception to the log

Parameters:

exception - the exception to log

fatal

public void fatal(java.lang.String content)

Writes a fatal-level message to the log

Parameters:

content - the message to log

log

public void log(java.lang.Exception exception,
                Logger.Level level)

Writes the exception to the log file at the given importance level

Parameters:

exception - the exception to log

level - the importance level of the message

log

public void log(java.lang.String content,
                Logger.Level level)

Writes the content to the log file at the given importance level

Parameters:

content - the message to log

level - the importance level of the message

output

public void output(java.lang.Exception exception)

Writes an output-level exception to the log

Parameters:

exception - the exception to log

output

public void output(java.lang.String content)

Writes an output-level message to the log

Parameters:

content - the message to log

setLevel

public void setLevel(Logger.Level level,
                     boolean only)

Sets the logger level. Logs above the importance of the set level will also be shown if only is set false.

Parameters:

level - the level to set

only - determines whether to only show logs at this level, or to also show logs of higher importance

verbose

public void verbose(java.lang.Exception exception)

Writes a verbose-level exception to the log

Parameters:

exception - the exception to log

verbose

public void verbose(java.lang.String content)

Writes a verbose-level message to the log

Parameters:

content - the message to log

warn

public void warn(java.lang.Exception exception)

Writes a warn-level exception to the log

Parameters:

exception - the exception to log

warn

public void warn(java.lang.String content)

Writes a warn-level message to the log

Parameters:

content - the message to log