Package com.storedobject.common

Class TranslatedOutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

com.storedobject.common.TranslatedOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public abstract class TranslatedOutputStream
extends FilterOutputStream

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

Author:

Syam

Field Summary

Fields

Modifier and Type	Field	Description
protected final BufferedInputStream	in	A BufferedInputStream used to read input data that needs to be translated before being written to the underlying output stream.
protected final OutputStream	out	The underlying output stream to which the translated data is written.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TranslatedOutputStream(OutputStream out)	Creates a new translated output stream.

Method Summary

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

Methods inherited from class java.io.FilterOutputStream

close, flush, write, write, write

Methods inherited from class java.io.OutputStream

nullOutputStream

Methods inherited from class java.lang.Object

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

Field Details

in

protected final BufferedInputStream in

A BufferedInputStream used to read input data that needs to be translated before being written to the underlying output stream. This variable is intended to serve as the source of data for the translation process. The translate() method of the enclosing class should read data from this stream, perform the translation, and write the results to the output stream.

out

protected final OutputStream out

The underlying output stream to which the translated data is written. This stream serves as the destination for the data after it has been translated by the translate() method of the enclosing TranslatedOutputStream class. The data processed from the BufferedInputStream variable in is transformed and ultimately written to this stream. This field is final, ensuring that the reference to the output stream cannot be reassigned after initialization.

Constructor Details

TranslatedOutputStream

protected TranslatedOutputStream(OutputStream out)

Creates a new translated output stream.

Parameters:

out - OutputStream object providing the underlying stream.

Method Details

translate

protected abstract void translate()
                           throws Exception

Translation should be done here. Original output stream is available in the variable out and the translated output should be written to it by reading the BufferedInputStream (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.