Package org.apache.tika.io

Class ProxyInputStream

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable
    Direct Known Subclasses:
    CloseShieldInputStream, CountingInputStream, TaggedInputStream
    public abstract class ProxyInputStream
extends java.io.FilterInputStream
    A Proxy stream which acts as expected, that is it passes the method calls on to the proxied stream and doesn't change which methods are being called.

    It is an alternative base class to FilterInputStream to increase reusability, because FilterInputStream changes the methods being called, such as read(byte[]) to read(byte[], int, int).

    See the protected methods for ways in which a subclass can easily decorate a stream with custom pre-, post- or error processing functionality.

    • Constructor Summary

      Constructors 
      Constructor Description
      ProxyInputStream​(java.io.InputStream proxy)
      Constructs a new ProxyInputStream.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int available()
      Invokes the delegate's available() method.
      void close()
      Invokes the delegate's close() method.
      void mark​(int readlimit)
      Invokes the delegate's mark(int) method.
      boolean markSupported()
      Invokes the delegate's markSupported() method.
      int read()
      Invokes the delegate's read() method.
      int read​(byte[] bts)
      Invokes the delegate's read(byte[]) method.
      int read​(byte[] bts, int off, int len)
      Invokes the delegate's read(byte[], int, int) method.
      void reset()
      Invokes the delegate's reset() method.
      long skip​(long ln)
      Invokes the delegate's skip(long) method.

      • Methods inherited from class java.io.InputStream

        nullInputStream, readAllBytes, readNBytes, readNBytes, transferTo

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ProxyInputStream

        public ProxyInputStream​(java.io.InputStream proxy)
        Constructs a new ProxyInputStream.
        Parameters:
        proxy - the InputStream to delegate to

    • Method Detail

      • read

        public int read()
         throws java.io.IOException
        Invokes the delegate's read() method.
        Overrides:
        read in class java.io.FilterInputStream
        Returns:
        the byte read or -1 if the end of stream
        Throws:
        java.io.IOException - if an I/O error occurs

      • read

        public int read​(byte[] bts)
         throws java.io.IOException
        Invokes the delegate's read(byte[]) method.
        Overrides:
        read in class java.io.FilterInputStream
        Parameters:
        bts - the buffer to read the bytes into
        Returns:
        the number of bytes read or -1 if the end of stream
        Throws:
        java.io.IOException - if an I/O error occurs

      • read

        public int read​(byte[] bts,
                int off,
                int len)
         throws java.io.IOException
        Invokes the delegate's read(byte[], int, int) method.
        Overrides:
        read in class java.io.FilterInputStream
        Parameters:
        bts - the buffer to read the bytes into
        off - The start offset
        len - The number of bytes to read
        Returns:
        the number of bytes read or -1 if the end of stream
        Throws:
        java.io.IOException - if an I/O error occurs

      • skip

        public long skip​(long ln)
          throws java.io.IOException
        Invokes the delegate's skip(long) method.
        Overrides:
        skip in class java.io.FilterInputStream
        Parameters:
        ln - the number of bytes to skip
        Returns:
        the actual number of bytes skipped
        Throws:
        java.io.IOException - if an I/O error occurs

      • available

        public int available()
              throws java.io.IOException
        Invokes the delegate's available() method.
        Overrides:
        available in class java.io.FilterInputStream
        Returns:
        the number of available bytes
        Throws:
        java.io.IOException - if an I/O error occurs

      • close

        public void close()
           throws java.io.IOException
        Invokes the delegate's close() method.
        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 - if an I/O error occurs

      • mark

        public void mark​(int readlimit)
        Invokes the delegate's mark(int) method.
        Overrides:
        mark in class java.io.FilterInputStream
        Parameters:
        readlimit - read ahead limit

      • reset

        public void reset()
           throws java.io.IOException
        Invokes the delegate's reset() method.
        Overrides:
        reset in class java.io.FilterInputStream
        Throws:
        java.io.IOException - if an I/O error occurs

      • markSupported

        public boolean markSupported()
        Invokes the delegate's markSupported() method.
        Overrides:
        markSupported in class java.io.FilterInputStream
        Returns:
        true if mark is supported, otherwise false