org.apache.tika.io
Class ProxyInputStream

java.lang.Object
  extended by java.io.InputStream
      extended by java.io.FilterInputStream
          extended by org.apache.tika.io.ProxyInputStream
All Implemented Interfaces:
java.io.Closeable
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).

Version:
$Id: ProxyInputStream.java 778043 2009-05-23 22:07:14Z jukka $
Author:
Stephen Colebourne

Field Summary
 
Fields inherited from class java.io.FilterInputStream
in
 
Constructor Summary
ProxyInputStream(java.io.InputStream proxy)
          Constructs a new ProxyInputStream.
 
Method Summary
 int available()
          Invokes the delegate's available() method.
 void close()
          Invokes the delegate's close() method.
protected  void handleIOException(java.io.IOException e)
          Handle any IOExceptions thrown.
 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.lang.Object
clone, equals, finalize, 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 number of bytes to skipped or -1 if the end of stream
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.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

handleIOException

protected void handleIOException(java.io.IOException e)
                          throws java.io.IOException
Handle any IOExceptions thrown.

This method provides a point to implement custom exception handling. The default behaviour is to re-throw the exception.

Parameters:
e - The IOException thrown
Throws:
java.io.IOException - if an I/O error occurs


Copyright © 2010 The Apache Software Foundation. All Rights Reserved.