ch.jalu.configme.beanmapper

Interface Mapper

All Known Implementing Classes:

DefaultMapper, MapperImpl

public interface Mapper

Creates JavaBeans based on the values coming from a property reader. See the JavaDoc on the default implementation, MapperImpl, for more details.

Method Summary

Modifier and Type	Method and Description
default <T> T	convertToBean(Object value, Class<T> clazz, ConvertErrorRecorder errorRecorder) Converts the given value to an object of the given class, if possible.
Object	convertToBean(Object value, TypeInformation typeInformation, ConvertErrorRecorder errorRecorder) Creates an object of the given type from the given value.
Object	toExportValue(Object object) Converts a complex type such as a JavaBean object to simple types suitable for exporting.

Method Detail

convertToBean

@Nullable
Object convertToBean(@Nullable
                               Object value,
                               TypeInformation typeInformation,
                               ConvertErrorRecorder errorRecorder)

Creates an object of the given type from the given value. Returns null if the conversion is not possible. The value usually stems from a property resource and is a Map of values.

Parameters:

value - the value to convert (typically a Map)

typeInformation - the required type

errorRecorder - error recorder to register errors even if a valid value is returned

Returns:

object of the given type, or null if not possible

convertToBean

@Nullable
default <T> T convertToBean(@Nullable
                                      Object value,
                                      Class<T> clazz,
                                      ConvertErrorRecorder errorRecorder)

Converts the given value to an object of the given class, if possible. Returns null otherwise. This is a convenience method as typed alternative to convertToBean(Object, TypeInformation, ConvertErrorRecorder).

Type Parameters:

T - the class type

Parameters:

value - the value to convert (typically a Map)

clazz - the required class

errorRecorder - error recorder to register errors even if a valid value is returned

Returns:

object of the given type, or null if not possible

toExportValue

@Nullable
Object toExportValue(@Nullable
                               Object object)

Converts a complex type such as a JavaBean object to simple types suitable for exporting. This method typically returns a Map of values, or simple types like String / Number for scalar values. Used in the TypeBasedProperty.toExportValue(T) method.

Parameters:

object - the object to convert to its export value

Returns:

export value to use