Package org.apache.commons.exec

Class LogOutputStream

  • All Implemented Interfaces:
    java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable
    public abstract class LogOutputStream
extends java.io.OutputStream
    Base class to connect a logging system to the output and/or error stream of then external process. The implementation parses the incoming data to construct a line and passes the complete line to a user-defined implementation.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private LogOutputStream.ByteArrayOutputStreamX buffer
      The internal buffer.
      private java.nio.charset.Charset charset
      Character Set to use when processing lines.
      private static int CR
      Carriage return.
      private static int INITIAL_SIZE
      Initial buffer size.
      private int level
      Level used to log data written to this stream.
      private static int LF
      Line-feed.
      private boolean skip
      Last written char was a CR.

    • Constructor Summary

      Constructors 
      Constructor Description
      LogOutputStream()
      Creates a new instance of this class.
      LogOutputStream​(int level)
      Creates a new instance of this class.
      LogOutputStream​(int level, java.nio.charset.Charset charset)
      Creates a new instance of this class, specifying the character set that should be used for outputting the string for each line

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      void close()
      Writes all remaining data from the buffer.
      void flush()
      Flushes this log stream.
      int getMessageLevel()
      Gets the trace level of the log system.
      protected void processBuffer()
      Converts the buffer to a string and sends it to processLine.
      protected void processLine​(java.lang.String line)
      Logs a line to the log system of the user.
      protected abstract void processLine​(java.lang.String line, int logLevel)
      Logs a line to the log system of the user.
      void write​(byte[] b, int off, int len)
      Writes a block of characters to the output stream.
      void write​(int cc)
      Writes the data to the buffer and flush the buffer, if a line separator is detected.

      • Methods inherited from class java.io.OutputStream

        write

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • INITIAL_SIZE

        private static final int INITIAL_SIZE
        Initial buffer size.
        See Also:
        Constant Field Values

      • skip

        private boolean skip
        Last written char was a CR.

      • level

        private final int level
        Level used to log data written to this stream.

      • charset

        private final java.nio.charset.Charset charset
        Character Set to use when processing lines.

    • Constructor Detail

      • LogOutputStream

        public LogOutputStream()
        Creates a new instance of this class. Uses the default level of 999.

      • LogOutputStream

        public LogOutputStream​(int level)
        Creates a new instance of this class.
        Parameters:
        level - level used to log data written to this stream.

      • LogOutputStream

        public LogOutputStream​(int level,
                       java.nio.charset.Charset charset)
        Creates a new instance of this class, specifying the character set that should be used for outputting the string for each line
        Parameters:
        level - level used to log data written to this stream.
        charset - Character Set to use when processing lines.

    • Method Detail

      • close

        public void close()
           throws java.io.IOException
        Writes all remaining data from the buffer.
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Overrides:
        close in class java.io.OutputStream
        Throws:
        java.io.IOException
        See Also:
        OutputStream.close()

      • flush

        public void flush()
        Flushes this log stream.
        Specified by:
        flush in interface java.io.Flushable
        Overrides:
        flush in class java.io.OutputStream
        See Also:
        OutputStream.flush()

      • getMessageLevel

        public int getMessageLevel()
        Gets the trace level of the log system.
        Returns:
        the trace level of the log system.

      • processBuffer

        protected void processBuffer()
        Converts the buffer to a string and sends it to processLine.

      • processLine

        protected void processLine​(java.lang.String line)
        Logs a line to the log system of the user.
        Parameters:
        line - the line to log.

      • processLine

        protected abstract void processLine​(java.lang.String line,
                                    int logLevel)
        Logs a line to the log system of the user.
        Parameters:
        line - the line to log.
        logLevel - the log level to use

      • write

        public void write​(byte[] b,
                  int off,
                  int len)
           throws java.io.IOException
        Writes a block of characters to the output stream.
        Overrides:
        write in class java.io.OutputStream
        Parameters:
        b - the array containing the data.
        off - the offset into the array where data starts.
        len - the length of block.
        Throws:
        java.io.IOException - if the data cannot be written into the stream.
        See Also:
        OutputStream.write(byte[], int, int)

      • write

        public void write​(int cc)
           throws java.io.IOException
        Writes the data to the buffer and flush the buffer, if a line separator is detected.
        Specified by:
        write in class java.io.OutputStream
        Parameters:
        cc - data to log (byte).
        Throws:
        java.io.IOException
        See Also:
        OutputStream.write(int)