Package com.twelvemonkeys.io

Class SubStream

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable
    public final class SubStream
extends java.io.FilterInputStream
    An InputStream reading up to a specified number of bytes from an underlying stream.
    Version:
    $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/SubStream.java#2 $
    Author:
    Harald Kuhr

    • Field Summary

      • Fields inherited from class java.io.FilterInputStream

        in

    • Constructor Summary

      Constructors 
      Constructor Description
      SubStream​(java.io.InputStream pStream, long pLength)
      Creates a SubStream of the given pStream.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int available()  
      void close()
      Marks this stream as closed.
      void mark​(int pReadLimit)  
      int read()  
      int read​(byte[] pBytes)  
      int read​(byte[] pBytes, int pOffset, int pLength)  
      void reset()  
      long skip​(long pLength)  

      • Methods inherited from class java.io.FilterInputStream

        markSupported

      • 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

      • SubStream

        public SubStream​(java.io.InputStream pStream,
                 long pLength)
        Creates a SubStream of the given pStream.
        Parameters:
        pStream - the underlying input stream
        pLength - maximum number of bytes to read drom this stream

    • Method Detail

      • close

        public void close()
           throws java.io.IOException
        Marks this stream as closed. This implementation does not close the underlying stream.
        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

      • available

        public int available()
              throws java.io.IOException
        Overrides:
        available in class java.io.FilterInputStream
        Throws:
        java.io.IOException

      • mark

        public void mark​(int pReadLimit)
        Overrides:
        mark in class java.io.FilterInputStream

      • reset

        public void reset()
           throws java.io.IOException
        Overrides:
        reset in class java.io.FilterInputStream
        Throws:
        java.io.IOException

      • read

        public int read()
         throws java.io.IOException
        Overrides:
        read in class java.io.FilterInputStream
        Throws:
        java.io.IOException

      • read

        public final int read​(byte[] pBytes)
               throws java.io.IOException
        Overrides:
        read in class java.io.FilterInputStream
        Throws:
        java.io.IOException

      • read

        public int read​(byte[] pBytes,
                int pOffset,
                int pLength)
         throws java.io.IOException
        Overrides:
        read in class java.io.FilterInputStream
        Throws:
        java.io.IOException

      • skip

        public long skip​(long pLength)
          throws java.io.IOException
        Overrides:
        skip in class java.io.FilterInputStream
        Throws:
        java.io.IOException