|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.io.Writer
java.io.PrintWriter
org.apache.derby.impl.services.stream.BasicHeaderPrintWriter
class BasicHeaderPrintWriter
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
|
private java.lang.String |
name
|
Fields inherited from class java.io.PrintWriter |
---|
out |
Fields inherited from class java.io.Writer |
---|
lock |
Constructor Summary | |
---|---|
BasicHeaderPrintWriter(java.io.OutputStream writeTo,
PrintWriterGetHeader headerGetter,
boolean canClose,
java.lang.String streamName)
the constructor sets up the HeaderPrintWriter. |
|
BasicHeaderPrintWriter(java.io.Writer writeTo,
PrintWriterGetHeader headerGetter,
boolean canClose,
java.lang.String writerName)
the constructor sets up the HeaderPrintWriter. |
Method Summary | |
---|---|
(package private) void |
complete()
Flushes stream, and optionally also closes it if constructed with canClose equal to true. |
PrintWriterGetHeader |
getHeader()
Return the header for the stream. |
java.lang.String |
getName()
Gets the name of the wrapped writer or 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 |
---|
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, 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 |
---|
private final PrintWriterGetHeader headerGetter
private final boolean canClose
private final java.lang.String name
Constructor Detail |
---|
BasicHeaderPrintWriter(java.io.OutputStream writeTo, PrintWriterGetHeader headerGetter, boolean canClose, java.lang.String streamName)
writeTo
- Where to write to.headerGetter
- Object to get headers for output lines.canClose
- If true, complete()
will also close writeTostreamName
- Name of writeTo, e.g. a file namePrintWriterGetHeader
BasicHeaderPrintWriter(java.io.Writer writeTo, PrintWriterGetHeader headerGetter, boolean canClose, java.lang.String writerName)
writeTo
- Where to write to.headerGetter
- Object to get headers for output lines.canClose
- If true, complete()
will also close writeTowriterName
- Name of writeTo, e.g. a file namePrintWriterGetHeader
Method Detail |
---|
public void printlnWithHeader(java.lang.String message)
HeaderPrintWriter
All other writes to the stream use the PrintStream interface.
printlnWithHeader
in interface HeaderPrintWriter
public PrintWriterGetHeader getHeader()
HeaderPrintWriter
getHeader
in interface HeaderPrintWriter
public java.io.PrintWriter getPrintWriter()
HeaderPrintWriter
getPrintWriter
in interface HeaderPrintWriter
public java.lang.String getName()
HeaderPrintWriter
getName
in interface HeaderPrintWriter
void complete()
|
Built on Thu 2011-03-10 11:54:14+0000, from revision ??? | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |