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

class BasicHeaderPrintWriter extends 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 Details

    • headerGetter

      private final PrintWriterGetHeader headerGetter
    • canClose

      private final boolean canClose
    • name

      private final String 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 writeTo
      streamName - 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 writeTo
      writerName - Name of writeTo, e.g. a file name
      See Also:
  • Method Details

    • printlnWithHeader

      public void printlnWithHeader(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 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
    • getName

      public String getName()
      Description copied from interface: HeaderPrintWriter
      Gets the name of the wrapped writer or stream
      Specified by:
      getName in interface HeaderPrintWriter
    • complete

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