org.apache.commons.io.input

Class ProxyReader

java.lang.Object

java.io.Reader

java.io.FilterReader

org.apache.commons.io.input.ProxyReader

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, java.lang.Readable

Direct Known Subclasses:

CloseShieldReader, TaggedReader, TeeReader

public abstract class ProxyReader
extends java.io.FilterReader

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 FilterReader to increase reusability, because FilterReader changes the methods being called, such as read(char[]) to read(char[], int, int).

Constructor Summary

Constructors

Constructor and Description
ProxyReader(java.io.Reader proxy) Constructs a new ProxyReader.

Method Summary

Modifier and Type	Method and Description
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(char[] chr) Invokes the delegate's read(char[]) method.
int	read(char[] chr, int st, int len) Invokes the delegate's read(char[], int, int) method.
int	read(java.nio.CharBuffer target) Invokes the delegate's read(CharBuffer) method.
boolean	ready() Invokes the delegate's ready() 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

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

Constructor Detail

ProxyReader

public ProxyReader(java.io.Reader proxy)

Constructs a new ProxyReader.

Parameters:

proxy - the Reader to delegate to

Method Detail

close

public void close()
           throws java.io.IOException

Invokes the delegate's close() method.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.FilterReader

Throws:

java.io.IOException - if an I/O error occurs.

mark

public void mark(int idx)
          throws java.io.IOException

Invokes the delegate's mark(int) method.

Overrides:

mark in class java.io.FilterReader

Parameters:

idx - read ahead limit

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.FilterReader

Returns:

true if mark is supported, otherwise false

read

public int read()
         throws java.io.IOException

Invokes the delegate's read() method.

Overrides:

read in class java.io.FilterReader

Returns:

the character read or -1 if the end of stream

Throws:

java.io.IOException - if an I/O error occurs.

read

public int read(char[] chr)
         throws java.io.IOException

Invokes the delegate's read(char[]) method.

Overrides:

read in class java.io.Reader

Parameters:

chr - the buffer to read the characters into

Returns:

the number of characters read or -1 if the end of stream

Throws:

java.io.IOException - if an I/O error occurs.

read

public int read(char[] chr,
                int st,
                int len)
         throws java.io.IOException

Invokes the delegate's read(char[], int, int) method.

Overrides:

read in class java.io.FilterReader

Parameters:

chr - the buffer to read the characters into

st - The start offset

len - The number of bytes to read

Returns:

the number of characters read or -1 if the end of stream

Throws:

java.io.IOException - if an I/O error occurs.

read

public int read(java.nio.CharBuffer target)
         throws java.io.IOException

Invokes the delegate's read(CharBuffer) method.

Specified by:

read in interface java.lang.Readable

Overrides:

read in class java.io.Reader

Parameters:

target - the char buffer to read the characters into

Returns:

the number of characters read or -1 if the end of stream

Throws:

java.io.IOException - if an I/O error occurs.

Since:

2.0

ready

public boolean ready()
              throws java.io.IOException

Invokes the delegate's ready() method.

Overrides:

ready in class java.io.FilterReader

Returns:

true if the stream is ready to be read

Throws:

java.io.IOException - if an I/O error occurs.

reset

public void reset()
           throws java.io.IOException

Invokes the delegate's reset() method.

Overrides:

reset in class java.io.FilterReader

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.FilterReader

Parameters:

ln - the number of bytes to skip

Returns:

the number of bytes to skipped or EOF if the end of stream

Throws:

java.io.IOException - if an I/O error occurs.