ma.glasnost.orika.converter.builtin

Class GuavaOptionalConverter<S,D>

java.lang.Object

ma.glasnost.orika.converter.builtin.GuavaOptionalConverter<S,D>

Type Parameters:

S - Type of the optional field to map from.

D - Type of the optional field to map to.

All Implemented Interfaces:

Converter<com.google.common.base.Optional<S>,com.google.common.base.Optional<D>>, MappedTypePair<com.google.common.base.Optional<S>,com.google.common.base.Optional<D>>

public class GuavaOptionalConverter<S,D>
extends Object
implements Converter<com.google.common.base.Optional<S>,com.google.common.base.Optional<D>>

Converter which will convert one Optional field into another optional field.

For those that wish to support the Java 8 java.util.Optional class, the code is exactly the same as this class apart from the static methods to construct the Optional classes.

Constructor Summary

Constructors

Constructor and Description
GuavaOptionalConverter(Type<S> sourceType, Type<D> destinationType) Construct a new Optional converter configured to convert an Optional field to another Optional field.

Method Summary

Modifier and Type	Method and Description
boolean	canConvert(Type<?> sourceType, Type<?> destinationType) Answers whether this converter can be used to handle the conversion of sourceType to destinationType.
com.google.common.base.Optional<D>	convert(com.google.common.base.Optional<S> optionalSource, Type<? extends com.google.common.base.Optional<D>> destinationType, MappingContext mappingContext) Perform the conversion of source into a new instance of destinationType.
Type<com.google.common.base.Optional<S>>	getAType()
Type<com.google.common.base.Optional<D>>	getBType()
void	setMapperFacade(MapperFacade mapper) Store an instance of the current MapperFacade which may be used in mapping of nested types.

Methods inherited from class java.lang.Object

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

Constructor Detail

GuavaOptionalConverter

public GuavaOptionalConverter(Type<S> sourceType,
                              Type<D> destinationType)

Construct a new Optional converter configured to convert an Optional field to another Optional field.

Parameters:

sourceType - Type the source Optional field contains.

destinationType - Type the destination Optional field will contain.

Method Detail

canConvert

public boolean canConvert(Type<?> sourceType,
                          Type<?> destinationType)

Description copied from interface: Converter

Answers whether this converter can be used to handle the conversion of sourceType to destinationType.

Specified by:

canConvert in interface Converter<com.google.common.base.Optional<S>,com.google.common.base.Optional<D>>

Returns:

convert

public com.google.common.base.Optional<D> convert(com.google.common.base.Optional<S> optionalSource,
                                                  Type<? extends com.google.common.base.Optional<D>> destinationType,
                                                  MappingContext mappingContext)

Description copied from interface: Converter

Perform the conversion of source into a new instance of destinationType.

Specified by:

convert in interface Converter<com.google.common.base.Optional<S>,com.google.common.base.Optional<D>>

Parameters:

optionalSource - the source object to be converted

destinationType - the destination type to produce

mappingContext - since converters now have access to MapperFacade, they have to pass mapping context

Returns:

a new instance of destinationType

setMapperFacade

public void setMapperFacade(MapperFacade mapper)

Description copied from interface: Converter

Store an instance of the current MapperFacade which may be used in mapping of nested types.

Specified by:

setMapperFacade in interface Converter<com.google.common.base.Optional<S>,com.google.common.base.Optional<D>>

Parameters:

mapper - the current MapperFacade

getAType

public Type<com.google.common.base.Optional<S>> getAType()

Specified by:

getAType in interface MappedTypePair<com.google.common.base.Optional<S>,com.google.common.base.Optional<D>>

Returns:

the 'A' type for this mapped pair

getBType

public Type<com.google.common.base.Optional<D>> getBType()

Specified by:

getBType in interface MappedTypePair<com.google.common.base.Optional<S>,com.google.common.base.Optional<D>>

Returns:

the 'B' type for this mapped pair