fr.xebia.extras.selma

Annotation Type Maps

@Target(value=METHOD)
@Inherited
public @interface Maps

Mapper annotation used to describe specific mappings for methods inside a mapper interface.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
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.
EnumMapper[]	withEnums Add one or more custom configuration for enum to enum mapping with default values.
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.

Element Detail

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

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:

{}

withEnums

public abstract EnumMapper[] withEnums

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

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:

{}

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:

{}

withCollectionStrategy

public abstract CollectionMappingStrategy withCollectionStrategy

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

Default:

fr.xebia.extras.selma.CollectionMappingStrategy.DEFAULT