org.apache.derby.iapi.services.stream
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
 void flush()
           
 PrintWriterGetHeader getHeader()
          Return the header for the stream.
 java.io.PrintWriter getPrintWriter()
          Gets a PrintWriter object for writing to this HeaderPrintWriter.
 void print(java.lang.String message)
           
 void println(java.lang.Object message)
           
 void println(java.lang.String message)
           
 void printlnWithHeader(java.lang.String message)
          Puts out some setup info for the current write and the write(s) that will be put out next.
 

Method Detail

printlnWithHeader

public void printlnWithHeader(java.lang.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

public PrintWriterGetHeader getHeader()
Return the header for the stream.


getPrintWriter

public java.io.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.


print

public void print(java.lang.String message)
See Also:
PrintWriter.print(char)

println

public void println(java.lang.String message)
See Also:
PrintWriter.println()

println

public void println(java.lang.Object message)
See Also:
PrintWriter.println()

flush

public void flush()
See Also:
PrintWriter.flush()


Apache Derby V10.0 Engine Documentation - Copyright © 1997,2004 The Apache Software Foundation or its licensors, as applicable.