Interface HeaderPrintWriter

All Known Implementing Classes:

BasicHeaderPrintWriter

public interface HeaderPrintWriter

A HeaderPrintWriter is like a PrintWriter with support for including a header in the output. It is expected users will use HeaderPrintWriters to prepend headings to trace and log messages.

Method Summary

Modifier and Type	Method	Description
void	flush()
PrintWriterGetHeader	getHeader()	Return the header for the stream.
String	getName()	Gets the name of the wrapped writer or stream
PrintWriter	getPrintWriter()	Gets a PrintWriter object for writing to this HeaderPrintWriter.
void	print(String message)
void	println(Object message)
void	println(String message)
void	printlnWithHeader(String message)	Puts out some setup info for the current write and the write(s) that will be put out next.

Method Details

printlnWithHeader

void printlnWithHeader(String message)

Puts out some setup info for the current write and the write(s) that will be put out next. It ends with a \n\r.

All other writes to the stream use the PrintStream interface.

getHeader

PrintWriterGetHeader getHeader()

Return the header for the stream.

getPrintWriter

PrintWriter getPrintWriter()

Gets a PrintWriter object for writing to this HeaderPrintWriter. Users may use the HeaderPrintWriter to access methods not included in this interface or to invoke methods or constructors which require a PrintWriter. Interleaving calls to a printWriter and its associated HeaderPrintWriter is not supported.

getName

String getName()

Gets the name of the wrapped writer or stream

print

void print(String message)

See Also:

• PrintWriter.print(boolean)

println

void println(String message)

See Also:

• PrintWriter.println()

println

void println(Object message)

See Also:

• PrintWriter.println()

flush

void flush()

See Also:

• PrintWriter.flush()