ch.jalu.configme.beanmapper

Interface MappingContext

All Known Implementing Classes:

MappingContextImpl

public interface MappingContext

Holds necessary information for a certain value that is being mapped in the bean mapper.

Method Summary

Modifier and Type	Method and Description
@NotNull MappingContext	createChild(@NotNull String name, @NotNull TypeInformation typeInformation) Creates a child context with the given path addition ("name") and type information.
@NotNull String	createDescription()
default @Nullable TypeInformation	getGenericTypeInfoOrFail(int index) Convenience method: gets the generic type info for the given index and ensures that the generic type information exists and that it can be converted into a safe-to-write class.
@NotNull TypeInformation	getTypeInformation()
void	registerError(@NotNull String reason) Registers an error during the mapping process, which delegates to the supplied ConvertErrorRecorder, associated to the property this conversion is being performed for.

Method Detail

createChild

@NotNull
@NotNull MappingContext createChild(@NotNull
                                             @NotNull String name,
                                             @NotNull
                                             @NotNull TypeInformation typeInformation)

Creates a child context with the given path addition ("name") and type information.

Parameters:

name - additional path element to append to this context's path

typeInformation - the required type

Returns:

new child context

getTypeInformation

@NotNull
@NotNull TypeInformation getTypeInformation()

Returns:

the required type the value needs to be mapped to

getGenericTypeInfoOrFail

@Nullable
default @Nullable TypeInformation getGenericTypeInfoOrFail(int index)

Convenience method: gets the generic type info for the given index and ensures that the generic type information exists and that it can be converted into a safe-to-write class. Throws an exception otherwise.

Parameters:

index - the index to get generic type info for

Returns:

the generic type info (throws exception if absent or not precise enough)

createDescription

@NotNull
@NotNull String createDescription()

Returns:

textual representation of the info in the context, used in exceptions

registerError

void registerError(@NotNull
                   @NotNull String reason)

Registers an error during the mapping process, which delegates to the supplied ConvertErrorRecorder, associated to the property this conversion is being performed for.

Parameters:

reason - the error reason (ignored by the default context implementation)