Package com.storedobject.common

Class TranslatedInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

com.storedobject.common.TranslatedInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public abstract class TranslatedInputStream
extends FilterInputStream

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

Author:

Syam

Field Summary

Fields

Modifier and Type	Field	Description
protected final InputStream	in	The input stream containing the original data to be translated.
protected final BufferedOutputStream	out	The buffered output stream used to hold the translated output data.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TranslatedInputStream(InputStream in)	Creates a new translated input stream.

Method Summary

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

Methods inherited from class java.io.FilterInputStream

available, close, mark, markSupported, read, read, read, reset, skip

Methods inherited from class java.io.InputStream

nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Field Details

in

protected final InputStream in

The input stream containing the original data to be translated. This stream serves as the source for translation operations performed by the translate() method.

• It is provided as a parameter during the construction of the containing class.
• Ensures the availability of unmodified input data before translation.
• Typically wrapped by a FilterInputStream for further processing.

This field is declared as protected to allow access in subclasses and final to ensure its reference cannot be changed.

out

protected final BufferedOutputStream out

The buffered output stream used to hold the translated output data. This stream serves as the target for translation operations performed by the translate() method.

• It is a BufferedOutputStream to optimize write operations.
• The data written to this stream reflects the translated content based on the original input stream in.
• Declared as protected to allow subclasses to access this stream for customized translation behavior.
• Declared as final to ensure its reference cannot be modified after initialization.

This field is initialized during the construction of the containing class and is automatically managed, being closed along with the associated input stream.

Constructor Details

TranslatedInputStream

protected TranslatedInputStream(InputStream in)

Creates a new translated input stream.

Parameters:

in - a InputStream object providing the underlying stream.

Method Details

translate

protected abstract void translate()
                           throws Exception

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

Throws:

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