de.cismet.commons.converter

Interface Converter<FROM,TO>

All Known Subinterfaces:

InputStreamConverter<TO>

public interface Converter<FROM,TO>

Converter interface which shall be used by classes that intend to implement bidirectional conversion of one type in another and vice versa.

Version:

1.0

Author:

martin.scholl@cismet.de

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Converter.MatchRating<FROM> This interface is intended to be implemented by converter implementations that want to provide a rating on how well the converter may convert the provided data, or in other word, how well the format of the provided data fits to the capabilities of the converter.

Method Summary

Modifier and Type	Method and Description
FROM	convertBackward(TO to, String... params) Converts a given instance TO back to the origin format FROM using the (optional) parameters.
TO	convertForward(FROM from, String... params) Converts a given instance FROM to the target format TO using the (optional) parameters.

Method Detail

convertForward

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

Converts a given instance FROM to the target format TO using the (optional) parameters.

Parameters:

from - the originating object that shall be converted to an instance of TO

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

Returns:

an instance of TO which was create from the FROM instance

Throws:

ConversionException - if any error occurs during conversion

convertBackward

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

Converts a given instance TO back to the origin format FROM using the (optional) parameters.

Parameters:

to - the converted object that shall be converted back to an instance of FROM

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

Returns:

an instance of FROM which was create from the TO instance

Throws:

ConversionException - if any error occurs during conversion