com.splicemachine.db.impl.services.stream

Class BasicHeaderPrintWriter

java.lang.Object

com.splicemachine.db.impl.services.stream.BasicHeaderPrintWriter

All Implemented Interfaces:

HeaderPrintWriter

class BasicHeaderPrintWriter
extends java.lang.Object
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.

Constructor Summary

Constructors

Constructor and Description
BasicHeaderPrintWriter(java.io.Writer writeTo, PrintWriterGetHeader headerGetter, boolean canClose, java.lang.String writerName) the constructor sets up the HeaderPrintWriter.

Method Summary

Modifier and Type	Method and Description
(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
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.
void	printStatement(java.lang.String statement)
void	printThrowable(java.lang.String message, java.lang.Throwable t)
void	printThrowable(java.lang.Throwable t)

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicHeaderPrintWriter

BasicHeaderPrintWriter(java.io.Writer writeTo,
                       PrintWriterGetHeader headerGetter,
                       boolean canClose,
                       java.lang.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 writeTo

writerName - Name of writeTo, e.g. a file name

See Also:

PrintWriterGetHeader

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

getName

public java.lang.String getName()

Description copied from interface: HeaderPrintWriter

Gets the name of the wrapped writer or stream

Specified by:

getName in interface HeaderPrintWriter

printStatement

public void printStatement(java.lang.String statement)

Specified by:

printStatement in interface HeaderPrintWriter

println

public void println(java.lang.String message)

Specified by:

println in interface HeaderPrintWriter

See Also:

PrintWriter.println()

printThrowable

public void printThrowable(java.lang.String message,
                           java.lang.Throwable t)

Specified by:

printThrowable in interface HeaderPrintWriter

printThrowable

public void printThrowable(java.lang.Throwable t)

Specified by:

printThrowable in interface HeaderPrintWriter

complete

void complete()

Flushes stream, and optionally also closes it if constructed with canClose equal to true.