Package com.google.common.io

Class CountingInputStream

    • Field Summary

      • Fields inherited from class java.io.

    • Constructor Summary

      Constructors 
      Constructor Description
       in)
      Wraps another input stream, counting the number of bytes read.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      long getCount()
      Returns the number of bytes read.
      void mark​(int readlimit)
      Marks the current position in this input stream.
      int read()
      Reads the next byte of data from this 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 reset()
      Repositions this stream to the position at the time the mark method was last called on this input stream.
      long skip​(long n)
      Skips over and discards n bytes of data from the input stream.

      • Methods inherited from class java.io.

        , , ,

      • Methods inherited from class java.io.

        , , , ,

      • Methods inherited from class java.lang.

        , , , , , , , , , ,

    • Constructor Detail

      • CountingInputStream

        public  in)
        Wraps another input stream, counting the number of bytes read.
        Parameters:
        in - the input stream to be wrapped

    • Method Detail

      • getCount

        public long getCount()
        Returns the number of bytes read.

      • read

        public int read()
         throws
        Description copied from class: 
        Reads the next byte of data from this 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.

        This method simply performs in.read() and returns the result.

        Overrides:
         in class 
        Returns:
        the next byte of data, or -1 if the end of the stream is reached.
        Throws:
        - if an I/O error occurs.
        See Also:

      • read

        public int read​(byte[] b,
                int off,
                int len)
         throws
        Description copied from class: 
        Reads up to len bytes of data from this input stream into an array of bytes. If len is not zero, the method blocks until some input is available; otherwise, no bytes are read and 0 is returned.

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

        Overrides:
         in class 
        Parameters:
        b - the buffer into which the data is read.
        off - the start offset in the destination array b
        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:
        - if an I/O error occurs.
        See Also:

      • skip

        public long skip​(long n)
          throws
        Description copied from class: 
        Skips over and discards n bytes of data from the input stream. The skip method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly 0. The actual number of bytes skipped is returned.

        This method simply performs in.skip(n).

        Overrides:
         in class 
        Parameters:
        n - the number of bytes to be skipped.
        Returns:
        the actual number of bytes skipped.
        Throws:
        - if in.skip(n) throws an IOException.

      • mark

        public void mark​(int readlimit)
        Description copied from class: 
        Marks the current position in this input stream. A subsequent call to the reset method repositions this stream at the last marked position so that subsequent reads re-read the same bytes.

        The readlimit argument tells this input stream to allow that many bytes to be read before the mark position gets invalidated.

        This method simply performs in.mark(readlimit).

        Overrides:
         in class 
        Parameters:
        readlimit - the maximum limit of bytes that can be read before the mark position becomes invalid.
        See Also:
        ,

      • reset

        public void reset()
           throws
        Description copied from class: 
        Repositions this stream to the position at the time the mark method was last called on this input stream.

        This method simply performs in.reset().

        Stream marks are intended to be used in situations where you need to read ahead a little to see what's in the stream. Often this is most easily done by invoking some general parser. If the stream is of the type handled by the parse, it just chugs along happily. If the stream is not of that type, the parser should toss an exception when it fails. If this happens within readlimit bytes, it allows the outer code to reset the stream and try another parser.

        Overrides:
         in class 
        Throws:
        - if the stream has not been marked or if the mark has been invalidated.
        See Also:
        ,