com.compoze.util.log
Class LogStream

java.lang.Object

  |

  +--java.io.OutputStream

        |

        +--java.io.FilterOutputStream

              |

              +--java.io.PrintStream

                    |

                    +--com.compoze.util.log.LogStream

All Implemented Interfaces:

ILogLevel

Direct Known Subclasses:

LogStream.ForceLevelStream, SystemLog

public class LogStream

extends java.io.PrintStream

implements ILogLevel

This class is a PrintStream that's used for logging and debugging. The date and current thread are printed with each line, and a debug and log level are allowed to limit the number of messages.

Inner Class Summary

class

LogStream.ForceLevelStream This class provides a wrapping print stream which forces the error level to a given value.

Fields inherited from class java.io.FilterOutputStream

out

Fields inherited from interface com.compoze.util.log.ILogLevel

DEBUG, DISABLED, ERROR, INFO, WARNING

Constructor Summary

LogStream(java.io.OutputStream os)
Constructor.

LogStream(java.io.OutputStream os, boolean bAutoFlush)
Constructor.

Method Summary

void	dumpStack() Dumps the current thread stack at debug level.
void	dumpStack(int iLevel) Dumps the current thread stack.
int	getDefaultLevel() Gets the default level used for messages without a level specified.
java.lang.String	getIdentifier() Gets the identifier printed in the log prefix.
int	getLevel() Gets the log level.
java.lang.String	getPrefix(int iLevel) Gets the prefix used for each line in the debug output.
void	print(boolean b) Prints a boolean.
void	print(boolean b, int iLevel) Prints a boolean.
void	print(char c) Prints a character.
void	print(double d) Prints a double.
void	print(float f) Prints a float.
void	print(int i) Prints an integer and terminates the line.
void	print(int iLevel, char c) Prints a character.
void	print(int iLevel, double d) Prints a double.
void	print(int iLevel, float f) Prints a float.
void	print(int iLevel, int i) Prints an integer and terminates the line.
void	print(int iLevel, long l) Prints a long.
void	print(int iLevel, java.lang.Object o) Prints an object.
void	print(int iLevel, short s) Prints a short.
void	print(int iLevel, java.lang.String s) Prints a string.
void	print(long l) Prints a long.
void	print(java.lang.Object o) Prints an object.
void	print(short s) Prints a short.
void	print(java.lang.String s) Prints a string.
void	printDebug(java.lang.String s) Prints a debug string and terminates the line.
void	printError(java.lang.String s) Prints an error string and terminates the line.
void	printInfo(java.lang.String s) Prints an informational string and terminates the line.
void	println(boolean b) Prints a boolean and terminate the line.
void	println(char c) Prints a character and terminate the line.
void	println(double d) Prints a double and terminate the line.
void	println(float f) Prints a float and terminates the line.
void	println(int i) Prints an integer and terminates the line.
void	println(int iLevel, boolean b) Prints a boolean and terminate the line.
void	println(int iLevel, char c) Prints a character and terminate the line.
void	println(int iLevel, double d) Prints a double and terminate the line.
void	println(int iLevel, float f) Prints a float and terminates the line.
void	println(int iLevel, int i) Prints an integer and terminates the line.
void	println(int iLevel, long l) Prints a long and terminates the line.
void	println(int iLevel, java.lang.Object o) Prints an object and terminates the line.
void	println(int iLevel, short s) Prints a short and terminate the line.
void	println(int iLevel, java.lang.String s) Prints a string and terminates the line.
void	println(long l) Prints a long and terminates the line.
void	println(java.lang.Object o) Prints a double and terminates the line.
void	println(short s) Prints a short and terminate the line.
void	println(java.lang.String s) Prints a string and terminates the line.
void	printStackTrace(int iLevel, java.lang.Throwable t) Prints a stack trace.
void	printStackTrace(java.lang.Throwable t) Prints a stack trace.
void	printWarning(java.lang.String s) Prints a warning string and terminates the line.
void	setDefaultLevel(int iDefaultLevel) Sets the default level used for messages without a level specified.
void	setIdentifier(java.lang.String sIdentifier) Sets the identifier printed in the log prefix.
void	setLevel(int iLogLevel) Sets the log level.

Methods inherited from class java.io.PrintStream

checkError, close, flush, print, println, println, 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

Constructor Detail

LogStream

public LogStream(java.io.OutputStream os)

Constructor.

Parameters:

os - underlying OutputStream

LogStream

public LogStream(java.io.OutputStream os,
                 boolean bAutoFlush)

Constructor.

Parameters:

os - underlying OutputStream

bAutoFlush - if true, flush at end of every line

Method Detail

println

public void println(boolean b)

Prints a boolean and terminate the line.

Overrides:

println in class java.io.PrintStream

Parameters:

b - boolean to print

println

public void println(int iLevel,
                    boolean b)

Prints a boolean and terminate the line.

Parameters:

iLevel - log level to use

b - boolean to print

print

public void print(boolean b)

Prints a boolean.

Overrides:

print in class java.io.PrintStream

Parameters:

b - boolean to print

print

public void print(boolean b,
                  int iLevel)

Prints a boolean.

Parameters:

b - boolean to print

iLevel - log level to use

println

public void println(char c)

Prints a character and terminate the line.

Overrides:

println in class java.io.PrintStream

Parameters:

c - char to print

println

public void println(int iLevel,
                    char c)

Prints a character and terminate the line.

Parameters:

iLevel - log level to use

c - char to print

print

public void print(char c)

Prints a character.

Overrides:

print in class java.io.PrintStream

Parameters:

c - char to print

print

public void print(int iLevel,
                  char c)

Prints a character.

Parameters:

iLevel - log level to use

c - char to print

println

public void println(short s)

Prints a short and terminate the line.

Parameters:

s - short to print

println

public void println(int iLevel,
                    short s)

Prints a short and terminate the line.

Parameters:

iLevel - log level to use

s - short to print

print

public void print(short s)

Prints a short.

Parameters:

s - short to print

print

public void print(int iLevel,
                  short s)

Prints a short.

Parameters:

iLevel - log level to use

s - short to print

println

public void println(int i)

Prints an integer and terminates the line.

Overrides:

println in class java.io.PrintStream

Parameters:

int - int to print

println

public void println(int iLevel,
                    int i)

Prints an integer and terminates the line.

Parameters:

iLevel - log level to use

int - int to print

print

public void print(int i)

Prints an integer and terminates the line.

Overrides:

print in class java.io.PrintStream

Parameters:

int - int to print

print

public void print(int iLevel,
                  int i)

Prints an integer and terminates the line.

Parameters:

iLevel - log level to use

int - int to print

println

public void println(long l)

Prints a long and terminates the line.

Overrides:

println in class java.io.PrintStream

Parameters:

l - long to print

println

public void println(int iLevel,
                    long l)

Prints a long and terminates the line.

Parameters:

iLevel - log level to use

l - long to print

print

public void print(long l)

Prints a long.

Overrides:

print in class java.io.PrintStream

Parameters:

l - long to print

print

public void print(int iLevel,
                  long l)

Prints a long.

Parameters:

iLevel - log level to use

l - long to print

println

public void println(float f)

Prints a float and terminates the line.

Overrides:

println in class java.io.PrintStream

Parameters:

f - float to print

println

public void println(int iLevel,
                    float f)

Prints a float and terminates the line.

Parameters:

iLevel - log level to use

f - float to print

print

public void print(float f)

Prints a float.

Overrides:

print in class java.io.PrintStream

Parameters:

f - float to print

print

public void print(int iLevel,
                  float f)

Prints a float.

Parameters:

iLevel - log level to use

f - float to print

println

public void println(double d)

Prints a double and terminate the line.

Overrides:

println in class java.io.PrintStream

Parameters:

d - double to print

println

public void println(int iLevel,
                    double d)

Prints a double and terminate the line.

Parameters:

iLevel - log level to use

d - double to print

print

public void print(double d)

Prints a double.

Overrides:

print in class java.io.PrintStream

Parameters:

d - double to print

print

public void print(int iLevel,
                  double d)

Prints a double.

Parameters:

iLevel - log level to use

d - double to print

println

public void println(java.lang.Object o)

Prints a double and terminates the line.

Overrides:

println in class java.io.PrintStream

Parameters:

o - Object to print

println

public void println(int iLevel,
                    java.lang.Object o)

Prints an object and terminates the line.

Parameters:

iLevel - log level to use

o - Object to print

print

public void print(java.lang.Object o)

Prints an object.

Overrides:

print in class java.io.PrintStream

Parameters:

o - Object to print

print

public void print(int iLevel,
                  java.lang.Object o)

Prints an object.

Parameters:

iLevel - log level to use

o - Object to print

println

public void println(java.lang.String s)

Prints a string and terminates the line.

Overrides:

println in class java.io.PrintStream

Parameters:

s - String to print

iLevel - log level to use

println

public void println(int iLevel,
                    java.lang.String s)

Prints a string and terminates the line.

Parameters:

iLevel - log level to use

s - String to print

printError

public void printError(java.lang.String s)

Prints an error string and terminates the line.

Parameters:

s - the string to print

printWarning

public void printWarning(java.lang.String s)

Prints a warning string and terminates the line.

Parameters:

s - the string to print

printInfo

public void printInfo(java.lang.String s)

Prints an informational string and terminates the line.

Parameters:

s - the string to print

printDebug

public void printDebug(java.lang.String s)

Prints a debug string and terminates the line.

Parameters:

s - the string to print

print

public void print(java.lang.String s)

Prints a string.

Overrides:

print in class java.io.PrintStream

Parameters:

s - the string to print

print

public void print(int iLevel,
                  java.lang.String s)

Prints a string.

Parameters:

iLevel - log level to use

s - the string to print

printStackTrace

public void printStackTrace(java.lang.Throwable t)

Prints a stack trace. The default level for stack trace is ERROR.

Parameters:

t - the Throwable to print the stack trace of

printStackTrace

public void printStackTrace(int iLevel,
                            java.lang.Throwable t)

Prints a stack trace.

Parameters:

iLevel - the log level

t - the Throwable to print the stack trace of

dumpStack

public void dumpStack(int iLevel)

Dumps the current thread stack.

Parameters:

iLevel - log level to use

dumpStack

public void dumpStack()

Dumps the current thread stack at debug level.

getPrefix

public java.lang.String getPrefix(int iLevel)

Gets the prefix used for each line in the debug output. This puts the current date and thread. If desired, this method may be overriden and used or not used.

Parameters:

iLevel -

Returns:

the prefix

getIdentifier

public java.lang.String getIdentifier()

Gets the identifier printed in the log prefix.

Returns:

the identifier

setIdentifier

public void setIdentifier(java.lang.String sIdentifier)

Sets the identifier printed in the log prefix.

Parameters:

sIdentifier - the identifier

setLevel

public void setLevel(int iLogLevel)

Sets the log level.

Parameters:

iLogLevel - the logging level

getLevel

public int getLevel()

Gets the log level.

Returns:

the logging level

setDefaultLevel

public void setDefaultLevel(int iDefaultLevel)

Sets the default level used for messages without a level specified.

Parameters:

iDefaultLevel - the default logging level for messages

getDefaultLevel

public int getDefaultLevel()

Gets the default level used for messages without a level specified.

Returns:

the default logging level for messages