Class AbstractValueConverter<F,T>

java.lang.Object

com.soklet.converter.AbstractValueConverter<F,T>

All Implemented Interfaces:

ValueConverter<F,T>

Direct Known Subclasses:

FromStringValueConverter

@ThreadSafe
public abstract class AbstractValueConverter<F,T>
extends Object
implements ValueConverter<F,T>

Convenience superclass which provides default implementations of ValueConverter methods.

Author:

Mark Allen

Constructor Summary

Constructors

Constructor	Description
AbstractValueConverter()	Supports subclasses that have both 'from' and 'to' generic types.
AbstractValueConverter(Type fromType)	Supports subclasses that have only a 'to' generic type, like FromStringValueConverter.

Method Summary

Modifier and Type	Method	Description
final Optional<T>	convert(F from)	Converts from to an instance of T.
Type	getFromType()	The 'converting from' type.
Type	getToType()	The 'converting to' type.
abstract Optional<T>	performConversion(F from)	Subclasses must implement this method to convert a 'from' instance to a 'to' instance.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

AbstractValueConverter

public AbstractValueConverter()

Supports subclasses that have both 'from' and 'to' generic types.

AbstractValueConverter

public AbstractValueConverter(@Nonnull
 Type fromType)

Supports subclasses that have only a 'to' generic type, like FromStringValueConverter.

Parameters:

fromType - an explicitly-provided 'from' type

Method Details

convert

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

Description copied from interface: ValueConverter

Converts from to an instance of T.

Specified by:

convert in interface ValueConverter<F,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

performConversion

@Nonnull
public abstract Optional<T> performConversion(@Nullable
 F from)
                                       throws Exception

Subclasses must implement this method to convert a 'from' instance to a 'to' instance.

Parameters:

from - the instance we are converting from

Returns:

an instance that was converted to

Throws:

Exception - if an error occured during conversion

getFromType

@Nonnull
public Type getFromType()

Description copied from interface: ValueConverter

The 'converting from' type.

Specified by:

getFromType in interface ValueConverter<F,T>

Returns:

the type represented by F

getToType

@Nonnull
public Type getToType()

Description copied from interface: ValueConverter

The 'converting to' type.

Specified by:

getToType in interface ValueConverter<F,T>

Returns:

the type represented by T

toString

@Nonnull
public String toString()

Overrides:

toString in class Object