Package com.storedobject.common

Class TranslatedReader

java.lang.Object

java.io.Reader

java.io.FilterReader

com.storedobject.common.TranslatedReader

All Implemented Interfaces:

Closeable, AutoCloseable, Readable

Direct Known Subclasses:

StringFillerReader

public abstract class TranslatedReader
extends FilterReader

A FilterReader that translates its stream on-the-fly.

Author:

Syam

Field Summary

Fields

Modifier and Type	Field	Description
protected final Reader	in	The underlying Reader providing the original input stream before translation.
protected final BufferedWriter	out	A BufferedWriter used to write the translated output of the input stream processed by this TranslatedReader.

Fields inherited from class java.io.Reader

lock

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TranslatedReader(Reader in)	Creates a new translated reader.

Method Summary

Modifier and Type	Method	Description
protected abstract void	translate()	Translation should be done here.

Methods inherited from class java.io.FilterReader

close, mark, markSupported, read, read, ready, reset, skip

Methods inherited from class java.io.Reader

nullReader, read, read, transferTo

Methods inherited from class java.lang.Object

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

Field Details

in

protected final Reader in

The underlying Reader providing the original input stream before translation. This reader is used as the source for processing in the translation logic defined in the translate() method.

out

protected final BufferedWriter out

A BufferedWriter used to write the translated output of the input stream processed by this TranslatedReader. This writer acts as the destination for the translated data after applying the custom translation logic defined in the translate() method. It is initialized to output to an underlying stream managed by this class.

Constructor Details

TranslatedReader

protected TranslatedReader(Reader in)

Creates a new translated reader.

Parameters:

in - Reader object providing the underlying stream.

Method Details

translate

protected abstract void translate()
                           throws Exception

Translation should be done here. Original reader is available in the variable in and the translated output should be written to the BufferedWriter (variable out).

Throws:

Exception - Throws any exception so that the ultimate reading program will get it.