org.apache.commons.io.input

Class ProxyInputStream

Known Direct Subclasses:
AutoCloseInputStream, CloseShieldInputStream, CountingInputStream, SwappedDataInputStream, TeeInputStream

public abstract class ProxyInputStream
extends 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 610010 2008-01-08 14:50:59Z niallp $
Author:
Stephen Colebourne

Constructor Summary

ProxyInputStream(InputStream proxy)
Constructs a new ProxyInputStream.

Method Summary

int
available()
Invokes the delegate's available() method.
void
close()
Invokes the delegate's close() method.
void
mark(int idx)
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 st, int end)
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.

Constructor Details

ProxyInputStream

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

Method Details

available

public int available()
            throws IOException
Invokes the delegate's available() method.
Returns:
the number of available bytes

close

public void close()
            throws IOException
Invokes the delegate's close() method.

mark

public void mark(int idx)
Invokes the delegate's mark(int) method.
Parameters:
idx - read ahead limit

markSupported

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

read

public int read()
            throws IOException
Invokes the delegate's read() method.
Returns:
the byte read or -1 if the end of stream

read

public int read(byte[] bts)
            throws IOException
Invokes the delegate's read(byte[]) method.
Parameters:
bts - the buffer to read the bytes into
Returns:
the number of bytes read or -1 if the end of stream

read

public int read(byte[] bts,
                int st,
                int end)
            throws IOException
Invokes the delegate's read(byte[], int, int) method.
Parameters:
bts - the buffer to read the bytes into
st - The start offset
end - The number of bytes to read
Returns:
the number of bytes read or -1 if the end of stream

reset

public void reset()
            throws IOException
Invokes the delegate's reset() method.

skip

public long skip(long ln)
            throws IOException
Invokes the delegate's skip(long) method.
Parameters:
ln - the number of bytes to skip
Returns:
the number of bytes to skipped or -1 if the end of stream

Copyright (c) 2002-2008 Apache Software Foundation