Interface ValueConverter<F,T>

All Known Implementing Classes:

AbstractValueConverter, FromStringValueConverter

public interface ValueConverter<F,T>

Contract for converting objects from one type to another.

For example, you might have a ValueConverter<String, List<Integer>> which converts text like "1,2,3" to a list of numbers.

Value conversion is documented in detail at https://www.soklet.com/docs/value-conversions.

Author:

Mark Allen

Method Summary

Modifier and Type	Method	Description
Optional<T>	convert(F from)	Converts from to an instance of T.
Type	getFromType()	The 'converting from' type.
Type	getToType()	The 'converting to' type.

Method Details

convert

@Nonnull
Optional<T> convert(@Nullable
 F from)
             throws ValueConversionException

Converts from to an instance of T.

Parameters:

from - the value from which to convert. May be null

Returns:

the T representation of from

Throws:

ValueConversionException - if an error occurs during conversion

getFromType

@Nonnull
Type getFromType()

The 'converting from' type.

Returns:

the type represented by F

getToType

@Nonnull
Type getToType()

The 'converting to' type.

Returns:

the type represented by T