de.christofreichardt.diagnosis.io

Class TracePrintStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

java.io.PrintStream

de.christofreichardt.diagnosis.io.IndentablePrintStream

de.christofreichardt.diagnosis.io.TracePrintStream

All Implemented Interfaces:

Indentable, Closeable, Flushable, Appendable, AutoCloseable

public class TracePrintStream
extends IndentablePrintStream

This is the main implementation of an indentable PrintStream. This stream uses a thread map to retrieve the current stack size and computes the extend of the indentation accordingly.

Author:

Christof Reichardt

Field Summary

Fields

Modifier and Type	Field and Description
static int	INDENT_CHAR_NUMBER number of spaces that should used per indentation
protected static String[]	INDENT_STRING string array that contains the indent strings
static int	MAX_INDENT_NUMBER indicates the maximum number of indentations
protected AbstractThreadMap	threadMap provides access to the tracing contexts indexed by thread objects

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Constructors

Constructor and Description
TracePrintStream() Creates a new instance by passing a NullOutputStream to the base class.
TracePrintStream(OutputStream out, AbstractThreadMap threadMap) Creates a new instance of TracePrintStream by passing the given OutputStream to the underlying PrintStream.

Method Summary

Modifier and Type	Method and Description
Indentable	printfIndentln(String format, Object... args) A convenience method to print an indented string onto the stream using the specified format string and the given arguments.
IndentablePrintStream	printIndent(String s) Prints an indented string.
IndentablePrintStream	printIndentln(String s) Prints an indented string together with a line feed.
IndentablePrintStream	printIndentString() Prints only the current indentation.

Methods inherited from class java.io.PrintStream

append, append, append, checkError, clearError, close, flush, format, format, print, print, print, print, print, print, print, print, print, printf, printf, println, println, println, println, println, println, println, println, 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

Field Detail

MAX_INDENT_NUMBER

public static final int MAX_INDENT_NUMBER

indicates the maximum number of indentations

See Also:

Constant Field Values

INDENT_CHAR_NUMBER

public static final int INDENT_CHAR_NUMBER

number of spaces that should used per indentation

See Also:

Constant Field Values

INDENT_STRING

protected static final String[] INDENT_STRING

string array that contains the indent strings

threadMap

protected final AbstractThreadMap threadMap

provides access to the tracing contexts indexed by thread objects

Constructor Detail

TracePrintStream

public TracePrintStream()

Creates a new instance by passing a NullOutputStream to the base class.

TracePrintStream

public TracePrintStream(OutputStream out,
                        AbstractThreadMap threadMap)

Creates a new instance of TracePrintStream by passing the given OutputStream to the underlying PrintStream. The threadMap will be needed to determine the current stack size and hence the indentation level.

Parameters:

out - the underlying OutputStream

threadMap - to compute the indentation level

Method Detail

printIndent

public IndentablePrintStream printIndent(String s)

Description copied from interface: Indentable

Prints an indented string.

Specified by:

printIndent in interface Indentable

Specified by:

printIndent in class IndentablePrintStream

Parameters:

s - the string to be printed

Returns:

the indentable stream itself

printIndentln

public IndentablePrintStream printIndentln(String s)

Description copied from interface: Indentable

Prints an indented string together with a line feed.

Specified by:

printIndentln in interface Indentable

Specified by:

printIndentln in class IndentablePrintStream

Parameters:

s - the string to be printed

Returns:

the indentable stream itself

printIndentString

public IndentablePrintStream printIndentString()

Description copied from interface: Indentable

Prints only the current indentation.

Specified by:

printIndentString in interface Indentable

Specified by:

printIndentString in class IndentablePrintStream

Returns:

the indentable stream itself

printfIndentln

public Indentable printfIndentln(String format,
                                 Object... args)

Description copied from interface: Indentable

A convenience method to print an indented string onto the stream using the specified format string and the given arguments.

Specified by:

printfIndentln in interface Indentable

Specified by:

printfIndentln in class IndentablePrintStream

Parameters:

format - the format string

args - the to be printed arguments

Returns:

the indentable stream itself