Interface HeaderPrintWriter

  • All Known Implementing Classes:
    BasicHeaderPrintWriter

    public interface HeaderPrintWriter
    A HeaderPrintWriter is like a PrintWriter with support for including a header in the output. It is expected users will use HeaderPrintWriters to prepend headings to trace and log messages.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void flush()  
      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 print​(java.lang.String message)  
      void println​(java.lang.Object message)  
      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.
    • Method Detail

      • printlnWithHeader

        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. It ends with a \n\r.

        All other writes to the stream use the PrintStream interface.

      • getPrintWriter

        java.io.PrintWriter getPrintWriter()
        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.
      • getName

        java.lang.String getName()
        Gets the name of the wrapped writer or stream
      • print

        void print​(java.lang.String message)
        See Also:
        PrintWriter.print(boolean)
      • println

        void println​(java.lang.String message)
        See Also:
        PrintWriter.println()
      • println

        void println​(java.lang.Object message)
        See Also:
        PrintWriter.println()
      • flush

        void flush()
        See Also:
        PrintWriter.flush()