com.gc.iotools.stream.reader
Class CloseShieldReader<T extends Reader>

java.lang.Object
  java.io.Reader
      com.gc.iotools.stream.reader.CloseShieldReader<T>

Type Parameters:

T - Type of the Reader passed in the constructor.

All Implemented Interfaces:

Closeable, Readable

public class CloseShieldReader<T extends Reader>
extends Reader

A CloseShieldReader wraps some other Reader, which it uses as its basic source of data. The class CloseShieldReader pass all requests to the contained stream, except the close() method that is not to the underlying stream.

This class is typically used in cases where a Reader needs to be passed to a component that wants to explicitly close the stream even if more input would still be available to other components.

Since:

1.2.8

Version:

$Id: CloseShieldReader.java 463 2011-01-21 23:54:17Z dvd.smnt@gmail.com $

Author:

dvd.smnt

Field Summary

Fields inherited from class java.io.Reader

lock

Constructor Summary

CloseShieldReader(T source)
Construct a CloseShieldReader that forwards the calls to the source Reader passed in the constructor.

Method Summary

void	close()
int	getCloseCount() Returns the number of time that close was called.
T	getWrappedReader() Returns the wrapped (original) Reader passed in the constructor.
void	mark(int readAheadLimit)
boolean	markSupported()
int	read()
int	read(char[] cbuf)
int	read(char[] cbuf, int off, int len)
int	read(CharBuffer target)
boolean	ready()
void	reset()
long	skip(long n)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CloseShieldReader

public CloseShieldReader(T source)

Construct a CloseShieldReader that forwards the calls to the source Reader passed in the constructor.

Type Parameters:

T - a T object.

Parameters:

source - original Reader

Method Detail

close

public void close()
           throws IOException

Multiple invocation of this method will result in only one invocation of the close() on the underlying stream.

Specified by:

close in interface Closeable

Specified by:

close in class Reader

Throws:

IOException

getCloseCount

public int getCloseCount()

Returns the number of time that close was called.

Returns:

Number of times that close was called

getWrappedReader

public T getWrappedReader()

Returns the wrapped (original) Reader passed in the constructor.

Returns:

The original Reader passed in the constructor

mark

public void mark(int readAheadLimit)
          throws IOException

Overrides:

mark in class Reader

Throws:

IOException

markSupported

public boolean markSupported()

Overrides:

markSupported in class Reader

read

public int read()
         throws IOException

Overrides:

read in class Reader

Throws:

IOException

read

public int read(char[] cbuf)
         throws IOException

Overrides:

read in class Reader

Throws:

IOException

read

public int read(char[] cbuf,
                int off,
                int len)
         throws IOException

Specified by:

read in class Reader

Throws:

IOException

read

public int read(CharBuffer target)
         throws IOException

Specified by:

read in interface Readable

Overrides:

read in class Reader

Throws:

IOException

ready

public boolean ready()
              throws IOException

Overrides:

ready in class Reader

Throws:

IOException

reset

public void reset()
           throws IOException

Overrides:

reset in class Reader

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class Reader

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object