Class ProxyReader
- All Implemented Interfaces:
- Closeable,- AutoCloseable,- Readable
- Direct Known Subclasses:
- CloseShieldReader,- TaggedReader,- TeeReader
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).
- 
Field SummaryFields inherited from class java.io.FilterReaderin
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionprotected voidafterRead(int n) Invoked by the read methods after the proxied call has returned successfully.protected voidbeforeRead(int n) Invoked by the read methods before the call is proxied.voidclose()Invokes the delegate'sclose()method.protected voidHandle any IOExceptions thrown.voidmark(int readAheadLimit) Invokes the delegate'smark(int)method.booleanInvokes the delegate'smarkSupported()method.intread()Invokes the delegate'sread()method.intread(char[] chr) Invokes the delegate'sread(char[])method.intread(char[] chr, int st, int len) Invokes the delegate'sread(char[], int, int)method.intread(CharBuffer target) Invokes the delegate'sread(CharBuffer)method.booleanready()Invokes the delegate'sready()method.voidreset()Invokes the delegate'sreset()method.longskip(long ln) Invokes the delegate'sskip(long)method.
- 
Constructor Details- 
ProxyReaderConstructs a new ProxyReader.- Parameters:
- delegate- the Reader to delegate to
 
 
- 
- 
Method Details- 
afterReadInvoked by the read methods after the proxied call has returned successfully. The number of chars returned to the caller (or -1 if the end of stream was reached) is given as an argument.Subclasses can override this method to add common post-processing functionality without having to override all the read methods. The default implementation does nothing. Note this method is not called from skip(long)orreset(). You need to explicitly override those methods if you want to add post-processing steps also to them.- Parameters:
- n- number of chars read, or -1 if the end of stream was reached
- Throws:
- IOException- if the post-processing fails
- Since:
- 2.0
 
- 
beforeReadInvoked by the read methods before the call is proxied. The number of chars that the caller wanted to read (1 for theread()method, buffer length forread(char[]), etc.) is given as an argument.Subclasses can override this method to add common pre-processing functionality without having to override all the read methods. The default implementation does nothing. Note this method is not called from skip(long)orreset(). You need to explicitly override those methods if you want to add pre-processing steps also to them.- Parameters:
- n- number of chars that the caller asked to be read
- Throws:
- IOException- if the pre-processing fails
- Since:
- 2.0
 
- 
closeInvokes the delegate'sclose()method.- Specified by:
- closein interface- AutoCloseable
- Specified by:
- closein interface- Closeable
- Overrides:
- closein class- FilterReader
- Throws:
- IOException- if an I/O error occurs.
 
- 
handleIOExceptionHandle any IOExceptions thrown.This method provides a point to implement custom exception handling. The default behavior is to re-throw the exception. - Parameters:
- e- The IOException thrown
- Throws:
- IOException- if an I/O error occurs.
- Since:
- 2.0
 
- 
markInvokes the delegate'smark(int)method.- Overrides:
- markin class- FilterReader
- Parameters:
- readAheadLimit- read ahead limit
- Throws:
- IOException- if an I/O error occurs.
 
- 
markSupportedInvokes the delegate'smarkSupported()method.- Overrides:
- markSupportedin class- FilterReader
- Returns:
- true if mark is supported, otherwise false
 
- 
readInvokes the delegate'sread()method.- Overrides:
- readin class- FilterReader
- Returns:
- the character read or -1 if the end of stream
- Throws:
- IOException- if an I/O error occurs.
 
- 
readInvokes the delegate'sread(char[])method.- Overrides:
- readin class- Reader
- Parameters:
- chr- the buffer to read the characters into
- Returns:
- the number of characters read or -1 if the end of stream
- Throws:
- IOException- if an I/O error occurs.
 
- 
readInvokes the delegate'sread(char[], int, int)method.- Overrides:
- readin class- 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:
- IOException- if an I/O error occurs.
 
- 
readInvokes the delegate'sread(CharBuffer)method.- Specified by:
- readin interface- Readable
- Overrides:
- readin class- 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:
- IOException- if an I/O error occurs.
- Since:
- 2.0
 
- 
readyInvokes the delegate'sready()method.- Overrides:
- readyin class- FilterReader
- Returns:
- true if the stream is ready to be read
- Throws:
- IOException- if an I/O error occurs.
 
- 
resetInvokes the delegate'sreset()method.- Overrides:
- resetin class- FilterReader
- Throws:
- IOException- if an I/O error occurs.
 
- 
skipInvokes the delegate'sskip(long)method.- Overrides:
- skipin class- FilterReader
- Parameters:
- ln- the number of bytes to skip
- Returns:
- the number of bytes to skipped or EOF if the end of stream
- Throws:
- IOException- if an I/O error occurs.
 
 
-