Package de.intarsys.tools.stream

Class LogInputStream

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable
    public class LogInputStream
extends java.io.FilterInputStream
    An InputStream that logs any char read.

    This stream is piped in the reading process, any characters read are written to an associated OutputStream object. 

     Client -> LogInputStream -> InputStream -> Source
            |
            v
           OutputStream

    • Field Summary

      • Fields inherited from class java.io.FilterInputStream

        in

    • Constructor Summary

      Constructors 
      Constructor Description
      LogInputStream​(java.io.InputStream newin, java.io.OutputStream newlog)
      SplitStream - Konstruktorkommentar.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void close()  
      java.io.OutputStream getLog()  
      int read()
      Reads the next byte of data from the input stream.
      int read​(byte[] b, int off, int len)
      Reads up to len bytes of data from this input stream into an array of bytes.
      void setLog​(java.io.OutputStream newLog)  

      • Methods inherited from class java.io.FilterInputStream

        available, mark, markSupported, read, reset, skip

      • Methods inherited from class java.io.InputStream

        nullInputStream, readAllBytes, readNBytes, readNBytes, transferTo

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • LogInputStream

        public LogInputStream​(java.io.InputStream newin,
                      java.io.OutputStream newlog)
        SplitStream - Konstruktorkommentar.
        Parameters:
        newin -
        newlog -

    • Method Detail

      • close

        public void close()
           throws java.io.IOException
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Overrides:
        close in class java.io.FilterInputStream
        Throws:
        java.io.IOException

      • getLog

        public java.io.OutputStream getLog()

      • read

        public int read()
         throws java.io.IOException
        Reads the next byte of data from the input stream. The value byte is returned as an int in the range 0 to 255. If no byte is available because the end of the stream has been reached, the value -1 is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.

        A subclass must provide an implementation of this method.

        Overrides:
        read in class java.io.FilterInputStream
        Returns:
        the next byte of data, or -1 if the end of the stream is reached.
        Throws:
        java.io.IOException - if an I/O error occurs.

      • read

        public int read​(byte[] b,
                int off,
                int len)
         throws java.io.IOException
        Reads up to len bytes of data from this input stream into an array of bytes. This method blocks until some input is available.

        This method simply performs in.read(b, off, len) and returns the result.

        Overrides:
        read in class java.io.FilterInputStream
        Parameters:
        b - the buffer into which the data is read.
        off - the start offset of the data.
        len - the maximum number of bytes read.
        Returns:
        the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.
        Throws:
        java.io.IOException - if an I/O error occurs.
        See Also:
        FilterInputStream.in

      • setLog

        public void setLog​(java.io.OutputStream newLog)