Package de.christofreichardt.diagnosis.io

Class IndentablePrintStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

java.io.PrintStream

de.christofreichardt.diagnosis.io.IndentablePrintStream

All Implemented Interfaces:

Indentable, Closeable, Flushable, Appendable, AutoCloseable

Direct Known Subclasses:

NullPrintStream, TracePrintStream

public abstract class IndentablePrintStream
extends PrintStream
implements Indentable

The base class of all indentable print streams.

Author:

Christof Reichardt

Field Summary

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Constructors

Constructor	Description
IndentablePrintStream(OutputStream out)	This constructor passes the given OutputStream to the underlying PrintStream implementation.

Method Summary

Modifier and Type	Method	Description
abstract void	lock()	Acquires a lock to prevent concurrent access to the IndentablePrintStream.
abstract IndentablePrintStream	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.
abstract IndentablePrintStream	printIndent(String s)	Prints an indented string.
abstract IndentablePrintStream	printIndentln(String s)	Prints an indented string together with a line feed.
abstract IndentablePrintStream	printIndentString()	Prints only the current indentation.
abstract void	runWithLock(Runnable runnable)	The given Runnable will be executed when the lock could be acquired.
abstract void	unlock()	Unlocks the lock.

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.io.OutputStream

nullOutputStream

Methods inherited from class java.lang.Object

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

Constructor Detail

IndentablePrintStream

public IndentablePrintStream(OutputStream out)

This constructor passes the given OutputStream to the underlying PrintStream implementation.

Parameters:

out - the desired OutputStream

Method Detail

printIndent

public abstract IndentablePrintStream printIndent(String s)

Description copied from interface: Indentable

Prints an indented string.

Specified by:

printIndent in interface Indentable

Parameters:

s - the string to be printed

Returns:

the indentable stream itself

printIndentln

public abstract IndentablePrintStream printIndentln(String s)

Description copied from interface: Indentable

Prints an indented string together with a line feed.

Specified by:

printIndentln in interface Indentable

Parameters:

s - the string to be printed

Returns:

the indentable stream itself

printIndentString

public abstract IndentablePrintStream printIndentString()

Description copied from interface: Indentable

Prints only the current indentation.

Specified by:

printIndentString in interface Indentable

Returns:

the indentable stream itself

printfIndentln

public abstract IndentablePrintStream 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

Parameters:

format - the format string

args - the to be printed arguments

Returns:

the indentable stream itself

lock

public abstract void lock()

Acquires a lock to prevent concurrent access to the IndentablePrintStream. This is useful if multiple threads are writing to the IndentablePrintStream.

unlock

public abstract void unlock()

Unlocks the lock.

runWithLock

public abstract void runWithLock(Runnable runnable)

The given Runnable will be executed when the lock could be acquired.

Parameters:

runnable - should contain print statements