com.rshtech.util
Class MessagePrinter

java.lang.Object
  com.rshtech.util.MessagePrinter

All Implemented Interfaces:

MessageLogger

public class MessagePrinter
extends java.lang.Object
implements MessageLogger

A primitive debugging/logging printer utility that prints messages and objects in a formatted manner to a PrintStream. This is not a substitute for proper logging packages, but is instead a shim to be used where logging would be inappropriate or top heavy. For instance, many frameworks are meant to be light-weight and universal; making them dependent on logging packages or configurations is not desirable. In such cases, a simple way to output is desirable.

This utility class is also useful in JUnit test cases, where "logging" output isn't useful or proper. In such cases, the utility methods for getting the name of the method, etc can be useful in making generic errror handling for templates, etc.

Version:

$Revision: 3127 $

Author:

$Author: kostya $

Field Summary

static int

DEFAULT_BANNER_LENGTH the default length of a banner

Constructor Summary

MessagePrinter()
Builds a message printer with the default outstream (System.out).

MessagePrinter(boolean likeLogger)
Builds a message printer with the default outstream (System.out).

MessagePrinter(java.io.PrintStream out)
Builds a message printer with the specified outstream.

MessagePrinter(java.io.PrintStream out, boolean likeLogger)
Builds a message printer with the specified outstream.

Method Summary

void	debug(java.lang.Object message)
void	debug(java.lang.Object message, java.lang.Throwable t)
void	error(java.lang.Object message)
void	error(java.lang.Object message, java.lang.Throwable t)
void	expectedError(java.lang.Throwable t)
void	fatal(java.lang.Object message)
void	fatal(java.lang.Object message, java.lang.Throwable t)
void	finished()
java.lang.String	format(java.lang.Object obj)
java.lang.String	getClassName() Return the class name for this message printer (useful for making generic unit test templates).
java.lang.String	getMethodName() Return the method name for this message printer (useful for making generic unit test templates).
void	info(java.lang.Object message)
void	info(java.lang.Object message, java.lang.Throwable t)
boolean	isDebugEnabled()
boolean	isErrorEnabled()
boolean	isFatalEnabled()
boolean	isInfoEnabled()
boolean	isPrintDebuggingMessages()
boolean	isTraceEnabled()
boolean	isWarnEnabled()
void	printBanner() Print a banner or section separator using "-" (makes a line 50 wide).
void	printBanner(java.lang.String p_str) Print a banner or section separator using p_str (makes a line of p_str 50 wide).
void	printBanner(java.lang.String p_str, int p_length) Print a banner or section separator using p_str (makes a line of p_str p_length wide).
void	println(boolean primitive) Print an primitive to the the outstream.
void	println(double primitive) Print an primitive to the the outstream.
void	println(float primitive) Print an primitive to the the outstream.
void	println(int primitive) Print an primitive to the the outstream.
void	println(long primitive) Print an primitive to the the outstream.
void	println(java.lang.Object message) Print an object message to the the outstream (uses the object formatter to create the string).
void	println(OutputPrefix prefix, java.lang.Object message)
void	println(OutputPrefix prefix, java.lang.String className, java.lang.String methodName, java.lang.Object message)
void	setPrintDebuggingMessages(boolean printDebuggingMessages)
void	starting()
void	trace(java.lang.Object message)
void	trace(java.lang.Object message, java.lang.Throwable t)
void	unexpectedError(java.lang.Throwable t)
void	warn(java.lang.Object message)
void	warn(java.lang.Object message, java.lang.Throwable t)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_BANNER_LENGTH

public static final int DEFAULT_BANNER_LENGTH

the default length of a banner

See Also:

Constant Field Values

Constructor Detail

MessagePrinter

public MessagePrinter()

Builds a message printer with the default outstream (System.out).

MessagePrinter

public MessagePrinter(java.io.PrintStream out)

Builds a message printer with the specified outstream.

MessagePrinter

public MessagePrinter(boolean likeLogger)

Builds a message printer with the default outstream (System.out).

MessagePrinter

public MessagePrinter(java.io.PrintStream out,
                      boolean likeLogger)

Builds a message printer with the specified outstream.

Method Detail

println

public void println(java.lang.Object message)

Print an object message to the the outstream (uses the object formatter to create the string).

Parameters:

message - object message to print

println

public void println(OutputPrefix prefix,
                    java.lang.Object message)

println

public void println(OutputPrefix prefix,
                    java.lang.String className,
                    java.lang.String methodName,
                    java.lang.Object message)

println

public void println(int primitive)

Print an primitive to the the outstream.

Parameters:

primitive - the primitive

println

public void println(long primitive)

Print an primitive to the the outstream.

Parameters:

primitive - the primitive

println

public void println(float primitive)

Print an primitive to the the outstream.

Parameters:

primitive - the primitive

println

public void println(double primitive)

Print an primitive to the the outstream.

Parameters:

primitive - the primitive

println

public void println(boolean primitive)

Print an primitive to the the outstream.

Parameters:

primitive - the primitive

starting

public void starting()

finished

public void finished()

printBanner

public void printBanner()

Print a banner or section separator using "-" (makes a line 50 wide).

printBanner

public void printBanner(java.lang.String p_str)

Print a banner or section separator using p_str (makes a line of p_str 50 wide).

printBanner

public void printBanner(java.lang.String p_str,
                        int p_length)

Print a banner or section separator using p_str (makes a line of p_str p_length wide).

getClassName

public java.lang.String getClassName()

Return the class name for this message printer (useful for making generic unit test templates).

Returns:

the class name

getMethodName

public java.lang.String getMethodName()

Return the method name for this message printer (useful for making generic unit test templates).

Returns:

the method name

unexpectedError

public void unexpectedError(java.lang.Throwable t)

expectedError

public void expectedError(java.lang.Throwable t)

format

public java.lang.String format(java.lang.Object obj)

trace

public void trace(java.lang.Object message)

Specified by:

trace in interface MessageLogger

trace

public void trace(java.lang.Object message,
                  java.lang.Throwable t)

Specified by:

trace in interface MessageLogger

debug

public void debug(java.lang.Object message)

Specified by:

debug in interface MessageLogger

debug

public void debug(java.lang.Object message,
                  java.lang.Throwable t)

Specified by:

debug in interface MessageLogger

info

public void info(java.lang.Object message)

Specified by:

info in interface MessageLogger

info

public void info(java.lang.Object message,
                 java.lang.Throwable t)

Specified by:

info in interface MessageLogger

warn

public void warn(java.lang.Object message)

Specified by:

warn in interface MessageLogger

warn

public void warn(java.lang.Object message,
                 java.lang.Throwable t)

Specified by:

warn in interface MessageLogger

error

public void error(java.lang.Object message)

Specified by:

error in interface MessageLogger

error

public void error(java.lang.Object message,
                  java.lang.Throwable t)

Specified by:

error in interface MessageLogger

fatal

public void fatal(java.lang.Object message)

Specified by:

fatal in interface MessageLogger

fatal

public void fatal(java.lang.Object message,
                  java.lang.Throwable t)

Specified by:

fatal in interface MessageLogger

isTraceEnabled

public boolean isTraceEnabled()

Specified by:

isTraceEnabled in interface MessageLogger

isDebugEnabled

public boolean isDebugEnabled()

Specified by:

isDebugEnabled in interface MessageLogger

isInfoEnabled

public boolean isInfoEnabled()

Specified by:

isInfoEnabled in interface MessageLogger

isWarnEnabled

public boolean isWarnEnabled()

Specified by:

isWarnEnabled in interface MessageLogger

isErrorEnabled

public boolean isErrorEnabled()

Specified by:

isErrorEnabled in interface MessageLogger

isFatalEnabled

public boolean isFatalEnabled()

Specified by:

isFatalEnabled in interface MessageLogger

isPrintDebuggingMessages

public boolean isPrintDebuggingMessages()

Returns:

Returns the printDebuggingMessages.

setPrintDebuggingMessages

public void setPrintDebuggingMessages(boolean printDebuggingMessages)

Parameters:

printDebuggingMessages - The printDebuggingMessages to set.