Package org.apache.tika.io

Class ProxyInputStream

java.lang.Object
java.io.InputStream
java.io.FilterInputStream
org.apache.tika.io.ProxyInputStream
All Implemented Interfaces:
Closeable, AutoCloseable
Direct Known Subclasses:
CloseShieldInputStream, CountingInputStream, TaggedInputStream
@Deprecated(since="2026-04-30") public abstract class ProxyInputStream extends FilterInputStream
Deprecated.
This version of the Apache Tika library is deprecated. Use your own version of Apache Tika.
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(InputStream proxy)
    Deprecated.
    Constructs a new ProxyInputStream.

  • Method Summary

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

    Methods inherited from class java.io.InputStream

    nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ProxyInputStream

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

  • Method Details

    • read

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

    • read

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

    • read

      public int read(byte[] bts, int off, int len) throws IOException
      Deprecated.
      Invokes the delegate's read(byte[], int, int) method.
      Overrides:
      read in class 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:
      IOException - if an I/O error occurs

    • skip

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

    • available

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

    • close

      public void close() throws IOException
      Deprecated.
      Invokes the delegate's close() method.
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable
      Overrides:
      close in class FilterInputStream
      Throws:
      IOException - if an I/O error occurs

    • mark

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

    • reset

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

    • markSupported

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