com.communote.common.io

Class DelimiterFilterReader

java.lang.Object

java.io.Reader

com.communote.common.io.DelimiterFilterReader

All Implemented Interfaces:

Closeable, AutoCloseable, Readable

public class DelimiterFilterReader
extends Reader

Reader that allows on-the-fly filtering of a character-stream read from another reader. The reader searches for character sequences that are surrounded by a start and an end delimiter. If such a sequence is found it is passed to the provided DelimiterFilterMatchProcessor which can manipulate the sequence before it is returned to the caller.

Since this reader is just reading from the provided reader, it is advisable to wrap that reader in a BufferedReader if the read operation is costly.

Note: the reader is not thread-safe

Author:

Communote GmbH - http://www.communote.com/

Field Summary

Fields inherited from class java.io.Reader

lock

Constructor Summary

Constructors

Constructor and Description
DelimiterFilterReader(Reader reader, String startDelimiter, String endDelimiter, DelimiterFilterMatchProcessor matchProcessor) Create a new filtering reader

Method Summary

Modifier and Type	Method and Description
void	close()
int	read()
int	read(char[] cbuf, int off, int len)
void	reset()

Methods inherited from class java.io.Reader

mark, markSupported, read, read, ready, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

DelimiterFilterReader

public DelimiterFilterReader(Reader reader,
                             String startDelimiter,
                             String endDelimiter,
                             DelimiterFilterMatchProcessor matchProcessor)

Create a new filtering reader

Parameters:

reader - the underlying reader that provides the character stream that should be filtered

startDelimiter - the delimiter marking the start of a match

endDelimiter - the delimiter marking the end of a match

matchProcessor - the processor to invoke when a match was found

Method Detail

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in class Reader

Throws:

IOException

read

public int read()
         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

reset

public void reset()
           throws IOException

Overrides:

reset in class Reader

Throws:

IOException