fr.xebia.extras.selma

Annotation Type Mapper

@Target(value=TYPE)
@Inherited
public @interface Mapper

Mapper annotation used to denote interfaces that needs mappers implementation to be built.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	ignoreMissingProperties Deprecated. since 0.10, please use withIgnoreMissing instead.
boolean	ignoreNotSupported Wether compilation should fail when Selma finds a situation where it can not generate mapping code.
CollectionMappingStrategy	withCollectionStrategy By default Selma uses a setter to provide new mapped collections.
Class<?>[]	withCustom Add a list of custom mapper class.
Field[]	withCustomFields This is used to describe specific field to field mapping.
boolean	withCyclicMapping Instance cache is used to handle circular references in objects mapped by Selma
EnumMapper[]	withEnums Add one or more custom configuration for enum to enum mapping with default values.
Class<?>[]	withFactories Add one or more class which should be used to create instances of the beans Selma will map.
boolean	withFinalMappers This allows to disable use of *final* modifier for generated mappers classes
String[]	withIgnoreFields This is used to describe fields to be ignored in the generated mapping methods.
IgnoreMissing	withIgnoreMissing How should selma processor handle properties not referenced in both bean.
boolean	withIgnoreNullValue This is used to not copy field with a null value
Class<?>[]	withImmutables This is used to declare custom immutable types.
String[]	withImmutablesPackages This is used to declare custom immutable types.
IoC	withIoC Defines the dependency injection model to be used.
String	withIoCServiceName Define the name of the service that will be used with the Spring annotations.
Class<?>[]	withSources Add one or more class for which instance should be passed to the out bean constructor.

Element Detail

ignoreMissingProperties

@Deprecated
public abstract boolean ignoreMissingProperties

Deprecated. since 0.10, please use withIgnoreMissing instead.

Wether compilation should fail when one field from in bean is missing in out bean
By default, compilation will fail and report error. Setting this to true will allow Selma to skip the missing field NO MAPPING CODE WILL BE GENERATED FOR THE MISSING FIELD.

Default:

false

withIgnoreMissing

public abstract IgnoreMissing withIgnoreMissing

How should selma processor handle properties not referenced in both bean. Set this to : IgnoreMissing.NONE if you want to selma to report compiler error for fields in source and destination that can not be mapped (this is the default value). IgnoreMissing.SOURCE if you want selma to report compiler error only for fields from destination bean that are missing in source. IgnoreMissing.DESTINATION if you want selma to report compiler error for fields from source bean that are missing in destination bean. IgnoreMising.ALL If you want selma to report compiler error for any missing fields from source bean and destination

Default:

fr.xebia.extras.selma.IgnoreMissing.DEFAULT

ignoreNotSupported

public abstract boolean ignoreNotSupported

Wether compilation should fail when Selma finds a situation where it can not generate mapping code.
Reason is not supported in base code for this Type to Type conversion. By default compilation should fail at code generation time. If you prefer to generate a method that raises UnsupportedException when trying to map the field set this to true.

Default:

false

withCustom

public abstract Class<?>[] withCustom

Add a list of custom mapper class. A custom mapper is a class that gives one or more method :

public OutType methodName(InType in)

These methods will be called to handle custom mapping of in bean to the OutType

Default:

{}

withSources

public abstract Class<?>[] withSources

Add one or more class for which instance should be passed to the out bean constructor. This aims to replace the use of a Factory, in fact if you need a factory, most of the time it is because beans have a specific constructor parameter that need to be filled in.

Returns:

Default:

{}

withFactories

public abstract Class<?>[] withFactories

Add one or more class which should be used to create instances of the beans Selma will map.

Returns:

Default:

{}

withEnums

public abstract EnumMapper[] withEnums

Add one or more custom configuration for enum to enum mapping with default values.

Default:

{}

withFinalMappers

public abstract boolean withFinalMappers

This allows to disable use of *final* modifier for generated mappers classes

Default:

true

withImmutables

public abstract Class<?>[] withImmutables

This is used to declare custom immutable types. Selma will copy by reference these types, when it meets same type for matching fields in source and destination bean.

Default:

{}

withImmutablesPackages

public abstract String[] withImmutablesPackages

This is used to declare custom immutable types. Selma will copy by reference any types inside this package, when it meets same type for matching fields in source and destination bean.

Default:

{}

withIgnoreFields

public abstract String[] withIgnoreFields

This is used to describe fields to be ignored in the generated mapping methods. This allows to skip specific properties not needed in the destination bean or missing from one or both source and destination bean. Please notice that all strings described here are ignoring case. This support 3 kinds of notations to describe the property to ignore :

• Only give the property name ("propertyName")
• Class and property name ("MyClass.propertyName")
• Fully qualified class and property name ("org.mypackage.MyClass.propertyName")

Default:

{}

withIgnoreNullValue

public abstract boolean withIgnoreNullValue

This is used to not copy field with a null value

Default:

false

withCustomFields

public abstract Field[] withCustomFields

This is used to describe specific field to field mapping. If you need field "toto" to be mapped to "tutu", you should add a @Field annotation here.

Default:

{}

withIoC

public abstract IoC withIoC

Defines the dependency injection model to be used. Supported models are :
NO used by default to disable dependency injection. SPRING will use Spring annotations to expose the implemented mapper in Spring and injects its dependencies.

Default:

fr.xebia.extras.selma.IoC.NO

withIoCServiceName

public abstract String withIoCServiceName

Define the name of the service that will be used with the Spring annotations. This is only usable with: withIoC = SPRING

Default:

""

withCollectionStrategy

public abstract CollectionMappingStrategy withCollectionStrategy

By default Selma uses a setter to provide new mapped collections. Passing this attribute to ALLOW_GETTER will make Selma use a getter to map collections if the setter does not exist.

Default:

fr.xebia.extras.selma.CollectionMappingStrategy.DEFAULT

withCyclicMapping

public abstract boolean withCyclicMapping

Instance cache is used to handle circular references in objects mapped by Selma

Default:

false