de.cismet.commons.converter

Interface InputStreamConverter<TO>

All Superinterfaces:

Converter<InputStream,TO>

public interface InputStreamConverter<TO>
extends Converter<InputStream,TO>

Specific converter that converts InputStreams to specific objects.

Version:

1.0

Author:

martin.scholl@cismet.de

Nested Class Summary

Nested classes/interfaces inherited from interface de.cismet.commons.converter.Converter

Converter.MatchRating<FROM>

Method Summary

Modifier and Type	Method and Description
InputStream	convertBackward(TO to, String... params) Creates an InputStream with the given object TO as source.
TO	convertForward(InputStream from, String... params) Creates an object TO from the given InputStream.

Method Detail

convertForward

TO convertForward(InputStream from,
                  String... params)
           throws ConversionException

Creates an object TO from the given InputStream. The InputStream shall not be closed by implementations. The users of this operation have to take care of the InputStream that is provided to this operation, thus they must take care of their resources themselves.

Specified by:

convertForward in interface Converter<InputStream,TO>

Parameters:

from - the InputStream that provides the information to create TO

params - optional parameters that may be passed to the converter that may influence conversion

Returns:

the desired object, created from the InputStream

Throws:

ConversionException - if any error occurs during conversion

convertBackward

InputStream convertBackward(TO to,
                            String... params)
                     throws ConversionException

Creates an InputStream with the given object TO as source. The InputStream shall not be closed by implementations. The users of this operation have to take care of the returned InputStream, thus they must take care of the resources themselves.

Specified by:

convertBackward in interface Converter<InputStream,TO>

Parameters:

to - the object TO that shall be turned into an InputStream

params - optional parameters that may be passed to the converter that may influence conversion

Returns:

an InputStream providing the data of the given object TO

Throws:

ConversionException - if any error occurs during conversion