de.unkrig.commons.io

Class TransformingFilterReader

java.lang.Object

java.io.Reader

java.io.FilterReader

de.unkrig.commons.io.TransformingFilterReader

All Implemented Interfaces:

Closeable, AutoCloseable, Readable

public class TransformingFilterReader
extends FilterReader

A FilterReader which transforms the character stream on-the-fly with a Transformer<? super CharSequence, ? super CharSequence>.

When the delegate reader is at end-of-input, then the transformer is invoked with an empty char sequence, which tells it to "flush itself". This is relevant for stateful transformers.

Field Summary

Fields inherited from class java.io.FilterReader

in

Fields inherited from class java.io.Reader

lock

Constructor Summary

Constructors

Constructor and Description
TransformingFilterReader(Reader delegate, TransformerWhichThrows<? super CharSequence,? extends CharSequence,? extends IOException> transformer)

Method Summary

Modifier and Type	Method and Description
static Reader	create(Reader delegate, TransformerWhichThrows<? super CharSequence,? extends CharSequence,? extends IOException> transformer) This method is sometimes more efficient than calling "new TransformingFilterReader()".
void	mark(int readAheadLimit)
boolean	markSupported()
int	read()
int	read(char[] cbuf, int off, int len)
boolean	ready()
void	reset()
long	skip(long n)

Methods inherited from class java.io.FilterReader

close

Methods inherited from class java.io.Reader

read, read

Methods inherited from class java.lang.Object

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

Constructor Detail

TransformingFilterReader

public TransformingFilterReader(Reader delegate,
                                TransformerWhichThrows<? super CharSequence,? extends CharSequence,? extends IOException> transformer)

Method Detail

create

public static Reader create(Reader delegate,
                            TransformerWhichThrows<? super CharSequence,? extends CharSequence,? extends IOException> transformer)

This method is sometimes more efficient than calling "new TransformingFilterReader()".

read

public int read()
         throws IOException

Overrides:

read in class FilterReader

Throws:

IOException

read

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

Overrides:

read in class FilterReader

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class FilterReader

Throws:

IOException

ready

public boolean ready()

Overrides:

ready in class FilterReader

markSupported

public boolean markSupported()

Overrides:

markSupported in class FilterReader

mark

public void mark(int readAheadLimit)
          throws IOException

Overrides:

mark in class FilterReader

Throws:

IOException

reset

public void reset()
           throws IOException

Overrides:

reset in class FilterReader

Throws:

IOException