Class BasicHeaderPrintWriter
java.lang.Object
java.io.Writer
java.io.PrintWriter
org.apache.derby.impl.services.stream.BasicHeaderPrintWriter
- All Implemented Interfaces:
Closeable
,Flushable
,Appendable
,AutoCloseable
,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
FieldsModifier and TypeFieldDescriptionprivate final boolean
private final PrintWriterGetHeader
private final String
Fields inherited from class java.io.PrintWriter
out
-
Constructor Summary
ConstructorsConstructorDescriptionBasicHeaderPrintWriter
(OutputStream writeTo, PrintWriterGetHeader headerGetter, boolean canClose, String streamName) the constructor sets up the HeaderPrintWriter.BasicHeaderPrintWriter
(Writer writeTo, PrintWriterGetHeader headerGetter, boolean canClose, String writerName) the constructor sets up the HeaderPrintWriter. -
Method Summary
Modifier and TypeMethodDescription(package private) void
complete()
Flushes stream, and optionally also closes it if constructed with canClose equal to true.Return the header for the stream.getName()
Gets the name of the wrapped writer or streamGets a PrintWriter object for writing to this HeaderPrintWriter.void
printlnWithHeader
(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.io.Writer
nullWriter
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 Details
-
headerGetter
-
canClose
private final boolean canClose -
name
-
-
Constructor Details
-
BasicHeaderPrintWriter
BasicHeaderPrintWriter(OutputStream writeTo, PrintWriterGetHeader headerGetter, boolean canClose, String streamName) the constructor sets up the HeaderPrintWriter.- Parameters:
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 name- See Also:
-
BasicHeaderPrintWriter
BasicHeaderPrintWriter(Writer writeTo, PrintWriterGetHeader headerGetter, boolean canClose, String writerName) the constructor sets up the HeaderPrintWriter.- Parameters:
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 name- See Also:
-
-
Method Details
-
printlnWithHeader
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 interfaceHeaderPrintWriter
-
getHeader
Description copied from interface:HeaderPrintWriter
Return the header for the stream.- Specified by:
getHeader
in interfaceHeaderPrintWriter
-
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 interfaceHeaderPrintWriter
-
getName
Description copied from interface:HeaderPrintWriter
Gets the name of the wrapped writer or stream- Specified by:
getName
in interfaceHeaderPrintWriter
-
complete
void complete()Flushes stream, and optionally also closes it if constructed with canClose equal to true.
-