Package com.storedobject.common

Class TranslatedWriter

java.lang.Object

java.io.Writer

java.io.FilterWriter

com.storedobject.common.TranslatedWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

Direct Known Subclasses:

StringFillerWriter

public abstract class TranslatedWriter
extends FilterWriter

A FilterWriter that translates its stream on-the-fly while writing.

Author:

Syam

Field Summary

Fields

Modifier and Type	Field	Description
protected final BufferedReader	in	A BufferedReader used to read input data for translation.
protected final Writer	out	The writer object to which the translated output is written.

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TranslatedWriter(Writer out)	Creates a new translated writer.

Method Summary

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

Methods inherited from class java.io.FilterWriter

close, flush, write, write, write

Methods inherited from class java.io.Writer

append, append, append, nullWriter, write, write

Methods inherited from class java.lang.Object

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

Field Details

in

protected final BufferedReader in

A BufferedReader used to read input data for translation. This stream serves as the source for data that needs to be processed and written to the output writer. It reads the raw input from the underlying input-output stream and is used in conjunction with the translate() method to perform on-the-fly translation of the input content. The lifecycle of this reader is managed internally, and it is expected to be closed automatically once the translation process is complete.

out

protected final Writer out

The writer object to which the translated output is written. This writer acts as the destination for the processed content after being translated by the translate() method. The lifecycle and closure of this writer are managed internally within the TranslatedWriter class to ensure resources are properly released after the translation process is completed. The translation process involves reading data from the BufferedReader (variable in), processing it, and then writing the resulting output to this writer.

Constructor Details

TranslatedWriter

protected TranslatedWriter(Writer out)

Creates a new translated writer.

Parameters:

out - Writer object providing the underlying stream.

Method Details

translate

protected abstract void translate()
                           throws Exception

Translation should be done here. Original writer is available in the variable out and the translated output should be written to it by reading the BufferedReader (variable in) and translating it (i.e., read from 'in', translate and write to 'out')

Throws:

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