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.

Generic type inference only supports direct AbstractValueConverter / FromStringValueConverter subclasses or direct ValueConverter implementations. If you introduce intermediate generic base classes or type variables (for example, abstract class BadConverter<T> extends AbstractValueConverter<String, T> then class JwtConverter extends BadConverter<Jwt>), Soklet may be unable to resolve F/T and will throw an IllegalStateException. This limitation may be addressed in a future release.

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

Author:

Mark Allen

Method Summary

Modifier and Type	Method	Description
@NonNull Optional<T>	convert(@Nullable F from)	Converts from to an instance of T.
@NonNull Type	getFromType()	The 'converting from' type.
@NonNull 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