org.apache.derby.impl.services.stream
Class BasicHeaderPrintWriter

java.lang.Object
  java.io.Writer
      java.io.PrintWriter
          org.apache.derby.impl.services.stream.BasicHeaderPrintWriter

All Implemented Interfaces:

HeaderPrintWriter

class BasicHeaderPrintWriter

extends java.io.PrintWriter

implements HeaderPrintWriter

Basic class to print lines with headers.

STUB: Should include code to emit a new line before a header which is not the first thing on the line.

Field Summary

private boolean	canClose
private PrintWriterGetHeader	headerGetter

Fields inherited from class java.io.PrintWriter

out

Fields inherited from class java.io.Writer

lock

Constructor Summary

(package private)	BasicHeaderPrintWriter(java.io.OutputStream writeTo, PrintWriterGetHeader headerGetter, boolean canClose) the constructor sets up the HeaderPrintWriter.
(package private)	BasicHeaderPrintWriter(java.io.Writer writeTo, PrintWriterGetHeader headerGetter, boolean canClose)

Method Summary

(package private) void	complete()
PrintWriterGetHeader	getHeader() Return the header for the stream.
java.io.PrintWriter	getPrintWriter() Gets a PrintWriter object for writing to this HeaderPrintWriter.
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.

Methods inherited from class java.io.PrintWriter

checkError, close, flush, print, print, print, print, print, print, print, print, print, println, println, println, println, println, println, println, println, println, println, setError, write, write, write, write, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.derby.iapi.services.stream.HeaderPrintWriter

flush, print, println, println

Field Detail

headerGetter

private final PrintWriterGetHeader headerGetter

canClose

private final boolean canClose

Constructor Detail

BasicHeaderPrintWriter

BasicHeaderPrintWriter(java.io.OutputStream writeTo,
                       PrintWriterGetHeader headerGetter,
                       boolean canClose)

the constructor sets up the HeaderPrintWriter.

Parameters:

writeTo - Where to write to.

headerGetter - Object to get headers for output lines.

See Also:

PrintWriterGetHeader

BasicHeaderPrintWriter

BasicHeaderPrintWriter(java.io.Writer writeTo,
                       PrintWriterGetHeader headerGetter,
                       boolean canClose)

Method Detail

printlnWithHeader

public void printlnWithHeader(java.lang.String message)

Description copied from interface: HeaderPrintWriter

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.

Specified by:

printlnWithHeader in interface HeaderPrintWriter

getHeader

public PrintWriterGetHeader getHeader()

Description copied from interface: HeaderPrintWriter

Return the header for the stream.

Specified by:

getHeader in interface HeaderPrintWriter

getPrintWriter

public java.io.PrintWriter getPrintWriter()

Description copied from interface: HeaderPrintWriter

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.

Specified by:

getPrintWriter in interface HeaderPrintWriter

complete

void complete()