ch.jalu.configme.beanmapper.leafvaluehandler

Interface LeafValueHandler

All Known Implementing Classes:

AbstractLeafValueHandler, CombiningLeafValueHandler, StandardLeafValueHandlers.BooleanHandler, StandardLeafValueHandlers.EnumHandler, StandardLeafValueHandlers.NumberHandler, StandardLeafValueHandlers.ObjectHandler, StandardLeafValueHandlers.StringHandler

public interface LeafValueHandler

A leaf value handler is used in MapperImpl to convert "simple" values from their read values to the desired type.

The bean mapper handles complex types such as maps and collections, and recursively calls the bean mapping process accordingly. This class complements the mapper by halting this process and providing "leaf values" to be set into Java beans.

Default implementation is provided by StandardLeafValueHandlers.getDefaultLeafValueHandler().

Method Summary

Modifier and Type	Method and Description
Object	convert(TypeInformation typeInformation, Object value) Converts the given value to the given class, if possible.
Object	toExportValue(Object value) Converts the given value to a type more suitable for exporting.

Method Detail

convert

@Nullable
Object convert(TypeInformation typeInformation,
                         @Nullable
                         Object value)

Converts the given value to the given class, if possible. Returns null otherwise. This method must either return null or an object of the class type.

Parameters:

typeInformation - the required type

value - the value to convert

Returns:

value of the given type, or null if not applicable

toExportValue

@Nullable
Object toExportValue(@Nullable
                               Object value)

Converts the given value to a type more suitable for exporting. Used by the mapper in when Property.toExportValue(T) is called on a bean property. Returns null if the leaf value handler cannot handle the value.

Return MapperImpl.RETURN_NULL to signal that null should be used as the export value (returning null itself means this leaf value handler cannot handle it).

Parameters:

value - the value to convert to an export value, if possible

Returns:

value to use in the export, or null if not applicable