org.apache.commons.io.input

Class ProxyInputStream

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
intavailable()
Invokes the delegate's available() method.
voidclose()
Invokes the delegate's close() method.
voidmark(int idx)
Invokes the delegate's mark(int) method.
booleanmarkSupported()
Invokes the delegate's markSupported() method.
intread()
Invokes the delegate's read() method.
intread(byte[] bts)
Invokes the delegate's read(byte[]) method.
intread(byte[] bts, int st, int end)
Invokes the delegate's read(byte[], int, int) method.
voidreset()
Invokes the delegate's reset() method.
longskip(long ln)
Invokes the delegate's skip(long) method.

Constructor Detail

ProxyInputStream

public ProxyInputStream(InputStream proxy)
Constructs a new ProxyInputStream.

Parameters: proxy the InputStream to delegate to

Method Detail

available

public int available()
Invokes the delegate's available() method.

Returns: the number of available bytes

Throws: IOException if an I/O error occurs

close

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

Throws: IOException if an I/O error occurs

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()
Invokes the delegate's read() method.

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)
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

Throws: IOException if an I/O error occurs

read

public int read(byte[] bts, int st, int end)
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

Throws: IOException if an I/O error occurs

reset

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

Throws: IOException if an I/O error occurs

skip

public long skip(long ln)
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

Throws: IOException if an I/O error occurs

Copyright (c) 2002-2011 Apache Software Foundation