MAPPER2Java Tools and Library

Instantiates and wraps a default Jakarta Commons Logger (JCL) for use by any MJ class.

Class: DebugPrintWriter next package

A PrintWriter that is enhanced for writing debug output to a file by conditionally writing messages depending on enabling of debug and including a prologue to message lines that can include the date/time, class and method.
Treat this class as "thread-hostile"; an instance of this class should be used by the same thread throughout the instance's existence, otherwise debug output will be intermixed and likely garbled.

 
  public class com.arsi.mj.logging.DebugPrintWriter

        extends java.io.PrintWriter

Fields

public static final java.lang.String DEBUG_DATE_FORMAT = "MM/dd/yyyy HH:mm:ss.SSS"

public static final java.lang.String DEBUG_FILE_SUFFIX = ".debug"

Constructors

Initializes an instance of this class.

Parameters:: aDebuggingFlag - if true, debugging is enabled, if false, this class should produce no output.
aDir - directory where debug output files are created.
aFilenamePrefix - prefix of debug output filename.
Throws:: IOException - if I/O error occurs creating writer.

public DebugPrintWriter(boolean aDebuggingFlag, java.io.File aDir, java.lang.String aFilenamePrefix)

  throws java.io.IOException

Initializes an instance of this class.

Parameters:: aDebuggingFlag - if true, debugging is enabled, if false, this class should produce no output.
aDir - directory where debug output files are created.
aFilenamePrefix - prefix of debug output filename.
anAppendFlag - if true, append messages to output file, otherwise overwrite existing file.
Throws:: IOException - if I/O error occurs creating writer.

public DebugPrintWriter(boolean aDebuggingFlag, java.io.File aDir, java.lang.String aFilenamePrefix, boolean anAppendFlag)

  throws java.io.IOException

Initializes an instance of this class.

Parameters:: aDebuggingFlag - if true, debugging is enabled, if false, this class should produce no output.
aDir - directory where debug output files are created.
aFilenamePrefix - prefix of debug output filename.
aThread - thread that is issuing debug messages, may be NULL.
anAppendFlag - if true, append messages to output file, otherwise overwrite existing file.
Throws:: IOException - if I/O error occurs creating writer.

public DebugPrintWriter(boolean aDebuggingFlag, java.io.File aDir, java.lang.String aFilenamePrefix, java.lang.Thread aThread, boolean anAppendFlag)

  throws java.io.IOException

Methods

public java.io.PrintWriter append(char c)

public java.io.PrintWriter append(java.lang.CharSequence csq)

public java.io.PrintWriter append(java.lang.CharSequence csq, int start, int end)

public boolean checkError()

public void close()

public void flush()

public java.io.PrintWriter format(java.util.Locale l, java.lang.String format, java.lang.Object args)

public java.io.PrintWriter format(java.lang.String format, java.lang.Object args)

public boolean isDebugging()

public void print(boolean x)

public void print(char x)

public void print(java.lang.Class aClass, java.lang.String aMethod, boolean x)

public void print(java.lang.Class aClass, java.lang.String aMethod, char x)

public void print(java.lang.Class aClass, java.lang.String aMethod, double x)

public void print(java.lang.Class aClass, java.lang.String aMethod, float x)

public void print(java.lang.Class aClass, java.lang.String aMethod, int x)

public void print(java.lang.Class aClass, java.lang.String aMethod, long x)

public void print(java.lang.Class aClass, java.lang.String aMethod, java.lang.Object x)

public void print(java.lang.Class aClass, java.lang.String aMethod, java.lang.String x)

public void print(double x)

public void print(float x)

public void print(int x)

public void print(long x)

public void print(java.lang.Object x)

public void print(java.lang.String x)

public void print(java.lang.String aMethodOrContext, boolean x)

public void print(java.lang.String aMethodOrContext, char x)

public void print(java.lang.String aMethodOrContext, double x)

public void print(java.lang.String aMethodOrContext, float x)

public void print(java.lang.String aMethodOrContext, int x)

public void print(java.lang.String aMethodOrContext, long x)

public void print(java.lang.String aMethodOrContext, java.lang.Object x)

public void print(java.lang.String aMethodOrContext, java.lang.String x)

public java.io.PrintWriter printf(java.util.Locale l, java.lang.String format, java.lang.Object args)

public java.io.PrintWriter printf(java.lang.String format, java.lang.Object args)

public void println()

public void println(boolean x)

public void println(char x)

public void println(java.lang.Class aClass, java.lang.String aMethod, boolean x)

public void println(java.lang.Class aClass, java.lang.String aMethod, char x)

public void println(java.lang.Class aClass, java.lang.String aMethod, double x)

public void println(java.lang.Class aClass, java.lang.String aMethod, float x)

public void println(java.lang.Class aClass, java.lang.String aMethod, int x)

public void println(java.lang.Class aClass, java.lang.String aMethod, long x)

public void println(java.lang.Class aClass, java.lang.String aMethod, java.lang.Object x)

public void println(java.lang.Class aClass, java.lang.String aMethod, java.lang.String x)

public void println(double x)

public void println(float x)

public void println(int x)

public void println(long x)

public void println(java.lang.Object x)

public void println(java.lang.String x)

public void println(java.lang.String aMethodOrContext, boolean x)

public void println(java.lang.String aMethodOrContext, char x)

public void println(java.lang.String aMethodOrContext, double x)

public void println(java.lang.String aMethodOrContext, float x)

public void println(java.lang.String aMethodOrContext, int x)

public void println(java.lang.String aMethodOrContext, long x)

public void println(java.lang.String aMethodOrContext, java.lang.Object x)

public void println(java.lang.String aMethodOrContext, java.lang.String x)

public java.lang.String prologue()

public java.lang.String prologue(java.lang.Class aClass, java.lang.String aMethod)

public java.lang.String prologue(java.lang.String aMethodOrContext)

public void setDebug(boolean anEnableFlag)
    throws java.io.IOException

public void write(char buf)

public void write(char buf, int off, int len)

public void write(int c)

public void write(java.lang.String s)

public void write(java.lang.String s, int off, int len)

Class: MJLogger previous package

Simple class that instantiates and wraps a default Jakarta Commons Logger (JCL) for use by any MJ class. JCL was used instead of SLF4J because it is built into Spring by default and, despite JCL's issues, it made sense to configure and use one logger SPI. Treat this class as "conditionally thread-safe", since it's thread safety depends on the underlying logger implementation and threading context of the caller.

 
  public class com.arsi.mj.logging.MJLogger

        extends java.lang.Object

Fields

The default logger.
public static final org.apache.commons.logging.Log defaultLogger

The JCL log object wrapped by this instance.
public final org.apache.commons.logging.Log log

Constructors

Ctor that uses default logger.
public MJLogger()

Ctor that accepts JCL Log object to wrap.

Parameters:: aLog - log object to wrap.

public MJLogger(org.apache.commons.logging.Log aLog)

Methods

Log message at debug level if such logging is enabled.

Parameters:: aMessage - a simple message that contains no replacement parameters.

public void debug(java.lang.String aMessage)

Log parameterized message at debug level if such logging is enabled.

Parameters:: aMessage - a message containing replacement parameters that is compatible with java.text.MessageFormat.
someMessageArgs - arguments that match position and type of replacement parameters in aMessage.

public void debug(java.lang.String aMessage, java.lang.Object someMessageArgs)

Log message and exception at debug level if such logging is enabled.

Parameters:: aMessage - a simple message that contains no replacement parameters.
t - exception to log with message.

public void debug(java.lang.String aMessage, java.lang.Throwable t)

Log parameterized message and exception at debug level if such logging is enabled.

Parameters:: aMessage - a message containing replacement parameters that is compatible with java.text.MessageFormat.
t - exception to log with message.
someMessageArgs - arguments that match position and type of replacement parameters in aMessage.

public void debug(java.lang.String aMessage, java.lang.Throwable t, java.lang.Object someMessageArgs)

Log message at error level if such logging is enabled.

Parameters:: aMessage - a simple message that contains no replacement parameters.

public void error(java.lang.String aMessage)

Log parameterized message at error level if such logging is enabled.

Parameters:: aMessage - a message containing replacement parameters that is compatible with java.text.MessageFormat.
someMessageArgs - arguments that match position and type of replacement parameters in aMessage.

public void error(java.lang.String aMessage, java.lang.Object someMessageArgs)

Log message and exception at error level if such logging is enabled.

Parameters:: aMessage - a simple message that contains no replacement parameters.
t - exception to log with message.

public void error(java.lang.String aMessage, java.lang.Throwable t)

Log parameterized message and exception at error level if such logging is enabled.

Parameters:: aMessage - a message containing replacement parameters that is compatible with java.text.MessageFormat.
t - exception to log with message.
someMessageArgs - arguments that match position and type of replacement parameters in aMessage.

public void error(java.lang.String aMessage, java.lang.Throwable t, java.lang.Object someMessageArgs)

Log message at fatal level if such logging is enabled.

Parameters:: aMessage - a simple message that contains no replacement parameters.

public void fatal(java.lang.String aMessage)

Log parameterized message at fatal level if such logging is enabled.

Parameters:: aMessage - a message containing replacement parameters that is compatible with java.text.MessageFormat.
someMessageArgs - arguments that match position and type of replacement parameters in aMessage.

public void fatal(java.lang.String aMessage, java.lang.Object someMessageArgs)

Log message and exception at fatal level if such logging is enabled.

Parameters:: aMessage - a simple message that contains no replacement parameters.
t - exception to log with message.

public void fatal(java.lang.String aMessage, java.lang.Throwable t)

Log parameterized message and exception at fatal level if such logging is enabled.

Parameters:: aMessage - a message containing replacement parameters that is compatible with java.text.MessageFormat.
t - exception to log with message.
someMessageArgs - arguments that match position and type of replacement parameters in aMessage.

public void fatal(java.lang.String aMessage, java.lang.Throwable t, java.lang.Object someMessageArgs)

Log message at info level if such logging is enabled.

Parameters:: aMessage - a simple message that contains no replacement parameters.

public void info(java.lang.String aMessage)

Log parameterized message at info level if such logging is enabled.

Parameters:: aMessage - a message containing replacement parameters that is compatible with java.text.MessageFormat.
someMessageArgs - arguments that match position and type of replacement parameters in aMessage.

public void info(java.lang.String aMessage, java.lang.Object someMessageArgs)

Log message and exception at info level if such logging is enabled.

Parameters:: aMessage - a simple message that contains no replacement parameters.
t - exception to log with message.

public void info(java.lang.String aMessage, java.lang.Throwable t)

Log parameterized message and exception at info level if such logging is enabled.

Parameters:: aMessage - a message containing replacement parameters that is compatible with java.text.MessageFormat.
t - exception to log with message.
someMessageArgs - arguments that match position and type of replacement parameters in aMessage.

public void info(java.lang.String aMessage, java.lang.Throwable t, java.lang.Object someMessageArgs)

Is logging enabled at debug level?
public boolean isDebugEnabled()

Is logging enabled at error level?
public boolean isErrorEnabled()

Is logging enabled at fatal level?
public boolean isFatalEnabled()

Is logging enabled at info level?
public boolean isInfoEnabled()

Is logging enabled at trace level?
public boolean isTraceEnabled()

Is logging enabled at warn level?
public boolean isWarnEnabled()

Log message at trace level if such logging is enabled.

Parameters:: aMessage - a simple message that contains no replacement parameters.

public void trace(java.lang.String aMessage)

Log parameterized message at trace level if such logging is enabled.

Parameters:: aMessage - a message containing replacement parameters that is compatible with java.text.MessageFormat.
someMessageArgs - arguments that match position and type of replacement parameters in aMessage.

public void trace(java.lang.String aMessage, java.lang.Object someMessageArgs)

Log message and exception at trace level if such logging is enabled.

Parameters:: aMessage - a simple message that contains no replacement parameters.
t - exception to log with message.

public void trace(java.lang.String aMessage, java.lang.Throwable t)

Log parameterized message and exception at trace level if such logging is enabled.

Parameters:: aMessage - a message containing replacement parameters that is compatible with java.text.MessageFormat.
t - exception to log with message.
someMessageArgs - arguments that match position and type of replacement parameters in aMessage.

public void trace(java.lang.String aMessage, java.lang.Throwable t, java.lang.Object someMessageArgs)

Log message at warn level if such logging is enabled.

Parameters:: aMessage - a simple message that contains no replacement parameters.

public void warn(java.lang.String aMessage)

Log parameterized message at warn level if such logging is enabled.

Parameters:: aMessage - a message containing replacement parameters that is compatible with java.text.MessageFormat.
someMessageArgs - arguments that match position and type of replacement parameters in aMessage.

public void warn(java.lang.String aMessage, java.lang.Object someMessageArgs)

Log message and exception at warn level if such logging is enabled.

Parameters:: aMessage - a simple message that contains no replacement parameters.
t - exception to log with message.

public void warn(java.lang.String aMessage, java.lang.Throwable t)

Log parameterized message and exception at warn level if such logging is enabled.

Parameters:: aMessage - a message containing replacement parameters that is compatible with java.text.MessageFormat.
t - exception to log with message.
someMessageArgs - arguments that match position and type of replacement parameters in aMessage.

public void warn(java.lang.String aMessage, java.lang.Throwable t, java.lang.Object someMessageArgs)

Classes and Interfaces
DebugPrintWriter	A `PrintWriter` that is enhanced for writing debug output to a file by conditionally writing messages depending on enabling of debug and including a prologue to message lines that can include the date/time, class and method.
MJLogger	Simple class that instantiates and wraps a default Jakarta Commons Logger (JCL) for use by any MJ class.

Package: com.arsi.mj.logging previous next contents

Class: DebugPrintWriter next package

Class: MJLogger previous package