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

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

Version:

$Id: ProxyReader.java 471628 2006-11-06 04:06:45Z bayard $

Author:

Stephen Colebourne

Field Summary

Fields inherited from class java.io.FilterReader

in

Fields inherited from class java.io.Reader

lock

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
void	mark(int idx)
boolean	markSupported()
int	read()
int	read(char[] chr)
int	read(char[] chr, int st, int end)
boolean	ready()
void	reset()
long	skip(long ln)

Methods inherited from class java.io.Reader

read

Methods inherited from class java.lang.Object

clone, equals, finalize, 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

read

public int read()
         throws java.io.IOException

Overrides:

read in class java.io.FilterReader

Throws:

java.io.IOException

See Also:

Reader.read()

read

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

Overrides:

read in class java.io.Reader

Throws:

java.io.IOException

See Also:

Reader.read(char[])

read

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

Overrides:

read in class java.io.FilterReader

Throws:

java.io.IOException

See Also:

Reader.read(char[], int, int)

skip

public long skip(long ln)
          throws java.io.IOException

Overrides:

skip in class java.io.FilterReader

Throws:

java.io.IOException

See Also:

Reader.skip(long)

ready

public boolean ready()
              throws java.io.IOException

Overrides:

ready in class java.io.FilterReader

Throws:

java.io.IOException

See Also:

Reader.ready()

close

public void close()
           throws java.io.IOException

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

See Also:

Reader.close()

mark

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

Overrides:

mark in class java.io.FilterReader

Throws:

java.io.IOException

See Also:

Reader.mark(int)

reset

public void reset()
           throws java.io.IOException

Overrides:

reset in class java.io.FilterReader

Throws:

java.io.IOException

See Also:

Reader.reset()

markSupported

public boolean markSupported()

Overrides:

markSupported in class java.io.FilterReader

See Also:

Reader.markSupported()