com.massa.util.convert

Interface IConverter

All Known Implementing Classes:

AbstractConverter, AddonConverter, BooleanConverter, CharacterConverter, ClassConverter, CollectionConverter, DateConverter, EnumConverter, IConverterWrapper, Jdk8DateTimeConverter, LocalImportHolderConverter, NumberConverter, PathConverter, PatternConverter, RounderConverter, StringConverter

public interface IConverter

Describes methods exposed by converters.

Method Summary

Modifier and Type	Method and Description
Object	convertArrayToString(Object o) Handles conversions of Arrays of Objects to Arrays of String.
Object	convertArrayToType(Class<?> type, Object o) Requests conversion to Arrays of one of the types handled by the IConverter.
Collection<?>	convertCollectionToString(Object o) Handles conversions of Collections of Objects to Collections of String.
Collection<?>	convertCollectionToType(Class<?> type, Object o) Requests conversion to Collections of one of the types handled by the IConverter.
String	convertToString(Object o) Requests conversion to a String for the provided Object.
<T> T	convertToType(Class<T> type, Object o) Requests conversion to a one of the types handled by the IConverter.
Class<?>[]	getTypes() Returns types handled by the converter.
Object	stringConversion(Object o) Requests to choose between convertToString(Object), convertArrayToString(Object) depending on provided Object type.
Object	typeConversion(Class<?> type, Object o) Requests to choose between convertToType(Class, Object), convertArrayToType(Class, Object) depending on provided Object type.

Method Detail

stringConversion

Object stringConversion(Object o)
                 throws UtilsException

Requests to choose between convertToString(Object), convertArrayToString(Object) depending on provided Object type.

Throws:

UtilsException

convertToString

String convertToString(Object o)
                throws UtilsException

Requests conversion to a String for the provided Object. The global contract is that the Object must be of a type handled by the IConverter, otherwise the default Object.toString() is invoked.
If an Array or a Collection is provided, returns the native toString. Use stringConversion(Object) in these cases.

Throws:

UtilsException

convertArrayToString

Object convertArrayToString(Object o)
                     throws UtilsException

Handles conversions of Arrays of Objects to Arrays of String.
The argument and return types has to be Object, as primitive or multi-dimensional Arrays can't be handled otherwise.
If provided Object is not an Array, the standard conversion to String is performed and the converted value is put in a 1-cell Array.

Throws:

UtilsException

convertCollectionToString

Collection<?> convertCollectionToString(Object o)
                                 throws UtilsException

Handles conversions of Collections of Objects to Collections of String.
The argument and return types has to be Object, as primitive or multi-dimensional Arrays can't be handled otherwise.
If provided Object is not an Array, the standard conversion to String is performed and the converted value is put in a 1-element Collection.

Throws:

UtilsException

typeConversion

Object typeConversion(Class<?> type,
                      Object o)
               throws UtilsException

Requests to choose between convertToType(Class, Object), convertArrayToType(Class, Object) depending on provided Object type.

Throws:

UtilsException

convertToType

<T> T convertToType(Class<T> type,
                    Object o)
             throws UtilsException

Requests conversion to a one of the types handled by the IConverter. If the type is not handled, an Exception will be raised.
The implementation must handle the special case when "type" is String.class, and redirect to stringConversion(Object).
If an Array or a Collection is provided, an Exception might be thrown. Use typeConversion(Class, Object) in these cases.

Throws:

UtilsException

convertArrayToType

Object convertArrayToType(Class<?> type,
                          Object o)
                   throws UtilsException

Requests conversion to Arrays of one of the types handled by the IConverter. If the type is not handled, an Exception will be raised.
The implementation must handle the special case when "type" is String.class, and redirect to stringConversion(Object).
If provided Object is not an Array, the standard conversion to type is performed and the converted value i put in a 1-cell Array.

Throws:

UtilsException

convertCollectionToType

Collection<?> convertCollectionToType(Class<?> type,
                                      Object o)
                               throws UtilsException

Requests conversion to Collections of one of the types handled by the IConverter. If the type is not handled, an Exception will be raised.
The implementation must handle the special case when "type" is String.class, and redirect to stringConversion(Object).
If provided Object is not an Array, the standard conversion to type is performed and the converted value is put in a 1-element Collection.

Throws:

UtilsException

getTypes

Class<?>[] getTypes()

Returns types handled by the converter. The Array must not contain the exhaustive list of types, but might just precise a common mother class. The Array might contain primitive types.