io.starter.toolkit

Class Logger

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

java.io.PrintStream

io.starter.toolkit.Logger

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public class Logger
extends PrintStream

System-wide Logging facility
Logger can be used to output standardized messages to System.out and System.err, as well as to pluggable Logger implementations.

To install a custom Logger implementation, instantiate a class that implements Logger, then set the system property: "io.starter.toolkit.logger"

For example:

  CustomLog mylogr = new CustomLog();
  Properties props = System.getProperties();
    props.put("io.starter.toolkit.logger", mylogr );
  

The default Logger settings can be controlled using System properties.

        props.put("io.starter.toolkit.logger.dateformat", "MMM yyyy mm:ss" );
        props.put("io.starter.toolkit.logger.dateformat", "none" );
 
 

Field Summary

Fields

Modifier and Type	Field and Description
static String	DATE_FORMAT The default time stamp format for getLogDate().
static String	ERROR_STRING
static String	INFO_STRING
protected PrintStream	ous Deprecated. Just use this.
static String	WARN_STRING

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Constructors

Constructor and Description
Logger(Logger target)
Logger(Logger target, String charset)
Logger(OutputStream target)
Logger(OutputStream target, boolean autoFlush)
Logger(OutputStream target, String charset, boolean autoFlush)
Logger(Writer target)
Logger(Writer target, boolean autoFlush)
Logger(Writer target, String charset, boolean autoFlush)

Method Summary

Modifier and Type	Method and Description
Logger	append(char value)
Logger	append(CharSequence value)
Logger	append(CharSequence value, int start, int end)
static String	formatThrowable(String message, Throwable ex, boolean trace)
static String	getLogDate() Returns the current time in a configurable format.
static Logger	getLogger() Gets the current system logger.
void	install() Installs this logger as the default logger and replaces the standard output and error streams.
static void	log(Object object) Logs the string conversion of an object to the system logger.
static void	log(String message)
void	log(String message, Exception ex)
void	log(String message, Exception ex, boolean trace)
static void	logErr(Exception ex) Logs the string conversion of an exception to the system logger as a fatal error message.
static void	logErr(String message) Logs a fatal error message to the system logger.
static void	logErr(String message, Exception ex) Logs a fatal error message to the system logger.
static void	logErr(String message, Exception ex, boolean trace) Logs a fatal error message to the system logger.
static void	logErr(String message, Throwable ex) Logs a fatal error message to the system logger.
static void	logInfo(String message) Logs an informational message to the system logger.
void	logLine()
static void	logWarn(String message) Logs a non-fatal warning to the system logger.
void	print(boolean b)
void	print(char c)
void	print(char[] s)
void	print(double d)
void	print(float f)
void	print(int i)
void	print(long l)
void	print(Object obj)
void	print(String s)
void	println()
void	println(boolean x)
void	println(char x)
void	println(char[] x)
void	println(double x)
void	println(float x)
void	println(int x)
void	println(long x)
void	println(Object x)
void	println(String x)
static void	setErr(String filename) Attempts to replace the standard error stream with a Logger instance that writes to the named file.
static void	setLogger(Logger logger) Replaces the system logger.
static void	setOut(String filename) Attempts to replace the standard output stream with a Logger instance that writes to the named file.

Methods inherited from class java.io.PrintStream

checkError, clearError, close, flush, format, format, printf, printf, setError, write, write

Methods inherited from class java.io.FilterOutputStream

write

Methods inherited from class java.lang.Object

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

Field Detail

ous

@Deprecated
protected PrintStream ous

Deprecated. Just use this.

INFO_STRING

public static final String INFO_STRING

See Also:

Constant Field Values

WARN_STRING

public static final String WARN_STRING

See Also:

Constant Field Values

ERROR_STRING

public static final String ERROR_STRING

See Also:

Constant Field Values

DATE_FORMAT

public static final String DATE_FORMAT

The default time stamp format for getLogDate().

See Also:

Constant Field Values

Constructor Detail

Logger

public Logger(Logger target)

Logger

public Logger(Logger target,
              String charset)
       throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

Logger

public Logger(OutputStream target)

Logger

public Logger(OutputStream target,
              boolean autoFlush)

Logger

public Logger(OutputStream target,
              String charset,
              boolean autoFlush)
       throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

Logger

public Logger(Writer target)

Logger

public Logger(Writer target,
              boolean autoFlush)

Logger

public Logger(Writer target,
              String charset,
              boolean autoFlush)
       throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

Method Detail

install

public void install()

Installs this logger as the default logger and replaces the standard output and error streams.

log

public static void log(String message)

log

public void log(String message,
                Exception ex,
                boolean trace)

log

public void log(String message,
                Exception ex)

logLine

public void logLine()

append

public Logger append(char value)

Specified by:

append in interface Appendable

Overrides:

append in class PrintStream

append

public Logger append(CharSequence value)

Specified by:

append in interface Appendable

Overrides:

append in class PrintStream

append

public Logger append(CharSequence value,
                     int start,
                     int end)

Specified by:

append in interface Appendable

Overrides:

append in class PrintStream

print

public void print(boolean b)

Overrides:

print in class PrintStream

print

public void print(char c)

Overrides:

print in class PrintStream

print

public void print(int i)

Overrides:

print in class PrintStream

print

public void print(long l)

Overrides:

print in class PrintStream

print

public void print(float f)

Overrides:

print in class PrintStream

print

public void print(double d)

Overrides:

print in class PrintStream

print

public void print(char[] s)

Overrides:

print in class PrintStream

print

public void print(String s)

Overrides:

print in class PrintStream

print

public void print(Object obj)

Overrides:

print in class PrintStream

println

public void println(boolean x)

Overrides:

println in class PrintStream

println

public void println(char x)

Overrides:

println in class PrintStream

println

public void println(int x)

Overrides:

println in class PrintStream

println

public void println(long x)

Overrides:

println in class PrintStream

println

public void println(float x)

Overrides:

println in class PrintStream

println

public void println(double x)

Overrides:

println in class PrintStream

println

public void println(char[] x)

Overrides:

println in class PrintStream

println

public void println(String x)

Overrides:

println in class PrintStream

println

public void println(Object x)

Overrides:

println in class PrintStream

println

public void println()

Overrides:

println in class PrintStream

getLogger

public static Logger getLogger()

Gets the current system logger.

setLogger

public static void setLogger(Logger logger)

Replaces the system logger.

formatThrowable

public static String formatThrowable(String message,
                                     Throwable ex,
                                     boolean trace)

logErr

public static void logErr(String message,
                          Exception ex)

Logs a fatal error message to the system logger.

logErr

public static void logErr(String message,
                          Throwable ex)

Logs a fatal error message to the system logger.

logErr

public static void logErr(String message)

Logs a fatal error message to the system logger.

logErr

public static void logErr(String message,
                          Exception ex,
                          boolean trace)

Logs a fatal error message to the system logger.

log

public static void log(Object object)

Logs the string conversion of an object to the system logger.

logWarn

public static void logWarn(String message)

Logs a non-fatal warning to the system logger.

logErr

public static void logErr(Exception ex)

Logs the string conversion of an exception to the system logger as a fatal error message.

logInfo

public static void logInfo(String message)

Logs an informational message to the system logger.

setOut

public static void setOut(String filename)

Attempts to replace the standard output stream with a Logger instance that writes to the named file. If the operation fails a message will be logged to the system logger and the method will return without throwing an exception.

setErr

public static void setErr(String filename)

Attempts to replace the standard error stream with a Logger instance that writes to the named file. If the operation fails a message will be logged to the system logger and the method will return without throwing an exception.

getLogDate

public static String getLogDate()

Returns the current time in a configurable format. If the system property io.starter.toolkit.logger.dateformat exists and is a valid date format pattern it will be used. Otherwise the default format pattern will be used.