ma.glasnost.orika

Class NullFilter<A,B>

java.lang.Object

ma.glasnost.orika.CustomFilter<A,B>

ma.glasnost.orika.NullFilter<A,B>

Type Parameters:

A -

B -

All Implemented Interfaces:

Filter<A,B>, MappedTypePair<A,B>

public class NullFilter<A,B>
extends CustomFilter<A,B>

A filter that does no filtering. This provides a useful base class for simple filters that just want to implement one facet.

Nested Class Summary

Nested classes/interfaces inherited from class ma.glasnost.orika.CustomFilter

CustomFilter.MappedTypePairHolder<A,B>

Constructor Summary

Constructors

Constructor and Description
NullFilter()

Method Summary

Modifier and Type	Method and Description
<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 class ma.glasnost.orika.CustomFilter

appliesTo, getAType, getBType, inferTypes

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NullFilter

public NullFilter()

Method Detail

filtersSource

public boolean filtersSource()

Description copied from interface: Filter

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:

false

filtersDestination

public boolean filtersDestination()

Description copied from interface: Filter

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:

false

shouldMap

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

Description copied from interface: Filter

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

filterDestination

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

Description copied from interface: Filter

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:

destinationValue

filterSource

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

Description copied from interface: Filter

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:

sourceValue