ma.glasnost.orika

Interface Filter<A,B>

Type Parameters:

A -

B -

All Superinterfaces:

MappedTypePair<A,B>

All Known Implementing Classes:

AggregateFilter, CustomFilter, NullFilter

public interface Filter<A,B>
extends MappedTypePair<A,B>

Filter defines the contract for manipulating the runtime behavior of generated mappers.

Author:

mattdeboer

Method Summary

Modifier and Type	Method and Description
boolean	appliesTo(Property source, Property destination) This method will be called at build time to determine if this filter should be applied to the mapping of the specified properties
<D extends B> D	filterDestination(D destinationValue, Type<?> sourceType, String sourceName, Type<D> destType, String destName, MappingContext mappingContext) This method is called to provide the Filter an opportunity to modify the destination field's value in some way before it is mapped onto the destination type.
boolean	filtersDestination() Called at code generation time to determine whether this filter modifies the destination.
<S extends A> S	filterSource(S sourceValue, Type<S> sourceType, String sourceName, Type<?> destType, String destName, MappingContext mappingContext) This method is called to provide the Filter an opportunity to replace the source field value before it is passed into the mapping code which transforms it to the destination type.
boolean	filtersSource() Called at code generation time to determine whether this filter modifies the source.
<S extends A,D extends B> boolean	shouldMap(Type<S> sourceType, String sourceName, S source, Type<D> destType, String destName, D dest, MappingContext mappingContext) This method is called at runtime to determine whether the mapping implied by the field names and types should be performed; if false is returned, the mapping is skipped.

Methods inherited from interface ma.glasnost.orika.MappedTypePair

getAType, getBType

Method Detail

appliesTo

boolean appliesTo(Property source,
                  Property destination)

This method will be called at build time to determine if this filter should be applied to the mapping of the specified properties

Parameters:

source - the source property

destination - the destination property

Returns:

true if this Filter applies

filtersSource

boolean filtersSource()

Called at code generation time to determine whether this filter modifies the source.

Implementations should not implement dynamic behavior here, as this method will most likely be called only once (at generation time) for a given Filter instance.

Returns:

true if this Filter should be called to filter the source value the mapping results

filtersDestination

boolean filtersDestination()

Called at code generation time to determine whether this filter modifies the destination.

Implementations should not implement dynamic behavior here, as this method will most likely be called only once (at generation time) for a given Filter instance.

Returns:

true if this Filter should be called to filter the destination of the mapping results

shouldMap

<S extends A,D extends B> boolean shouldMap(Type<S> sourceType,
                                            String sourceName,
                                            S source,
                                            Type<D> destType,
                                            String destName,
                                            D dest,
                                            MappingContext mappingContext)

This method is called at runtime to determine whether the mapping implied by the field names and types should be performed; if false is returned, the mapping is skipped.

Parameters:

sourceType - the type of the source field

sourceName - the name of the source field

source - the value of the source field

destType - the type of the destination field

destName - the name of the destination field

dest - the value of the destination field

mappingContext - the current mapping context

Returns:

true if the fields represented by these types and names

filterDestination

<D extends B> D filterDestination(D destinationValue,
                                  Type<?> sourceType,
                                  String sourceName,
                                  Type<D> destType,
                                  String destName,
                                  MappingContext mappingContext)

This method is called to provide the Filter an opportunity to modify the destination field's value in some way before it is mapped onto the destination type.

Note that the return value should still be an instance of the provided destination type, else ClassCastException will likely occur.

Parameters:

destinationValue - the destination value

sourceType - the type of the source field

sourceName - the name of the source field

destType - the type of the destination field

destName - the name of the destination field

mappingContext - the current mapping context

Returns:

the filtered output value

filterSource

<S extends A> S filterSource(S sourceValue,
                             Type<S> sourceType,
                             String sourceName,
                             Type<?> destType,
                             String destName,
                             MappingContext mappingContext)

This method is called to provide the Filter an opportunity to replace the source field value before it is passed into the mapping code which transforms it to the destination type.

It's recommended that the filter should return a new instance if it's necessary to modify the source, as a mapping request is not generally expected to have side effects on the source.

Parameters:

sourceValue - the source value

sourceType - the type of the source field

sourceName - the name of the source field

destType - the type of the destination field

destName - the name of the destination field

mappingContext - the current mapping context

Returns:

the filtered output value