cn.crane4j.annotation

注释类型 AssembleEnum

@Repeatable(value=AssembleEnum.List.class)
 @Documented
 @Target(value={ANNOTATION_TYPE,FIELD,TYPE,METHOD})
 @Retention(value=RUNTIME)
public @interface AssembleEnum

Declare an operation of assemble based on enum container.

作者:

huangchengxing

另请参阅:

cn.crane4j.core.parser.TypeHierarchyBeanOperationParser;, cn.crane4j.core.parser.handler.AssembleEnumAnnotationHandler;

必需元素概要

所需元素

限定符和类型	必需的元素和说明
Class<? extends Enum<?>>	type Enum class.

可选元素概要

可选元素

限定符和类型	可选元素和说明
String	enumKey Enum key field name.
String	enumValue Enum value field name.
String[]	groups The group to which the current operation belongs.
String	handler The name of the handler to be used.
Class<?>	handlerType The type of the handler to be used.
String	key Field name of key.
String	propertyMappingStrategy Get name of property mapping strategy.
Mapping[]	props Attributes that need to be mapped between the data source object and the current object.
Class<?>[]	propTemplates Mapping template classes.
String	ref a quick set for reference field name, equivalent to @Mapping(ref = "").
int	sort Sort values.
boolean	useContainerEnum If the type() is annotated with ContainerEnum, the configuration defined by that annotation will be used first.

元素详细资料

type

public abstract Class<? extends Enum<?>> type

Enum class.

返回:

enum class

enumKey

public abstract String enumKey

Enum key field name.

返回:

field name

默认值:

""

enumValue

public abstract String enumValue

Enum value field name.

返回:

field name

默认值:

""

ref

public abstract String ref

a quick set for reference field name, equivalent to @Mapping(ref = "").
when not empty, the value is jointly effective with props().

返回:

reference field name

另请参阅:

props()

默认值:

""

useContainerEnum

public abstract boolean useContainerEnum

If the type() is annotated with ContainerEnum, the configuration defined by that annotation will be used first.

返回:

boolean

默认值:

true

key

public abstract String key

Field name of key.
This field value will be used to obtain the associated data source object from the data source container later.

When the annotation is on:

• field of this class, it will be forced to specify the name of the annotated attribute, the key value is the field value of current object;
• this class, and specify key, equivalent to directly annotating on a specified field;
• this class, and key is empty, the key value is the current object itself.

返回:

field name of key

默认值:

""

sort

public abstract int sort

Sort values. The lower the value, the higher the priority.

返回:

sort values

默认值:

2147483647

handler

public abstract String handler

The name of the handler to be used.

返回:

name

另请参阅:

cn.crane4j.core.executor.handler.AssembleOperationHandler;

默认值:

""

handlerType

public abstract Class<?> handlerType

The type of the handler to be used.

返回:

name

另请参阅:

cn.crane4j.core.executor.handler.AssembleOperationHandler;

默认值:

java.lang.Object.class

props

public abstract Mapping[] props

Attributes that need to be mapped between the data source object and the current object.

返回:

attributes

另请参阅:

propTemplates()

默认值:

{}

propTemplates

public abstract Class<?>[] propTemplates

Mapping template classes. specify a class, if MappingTemplate exists on the class, it will scan and add Mapping to props()。

返回:

mapping templates

默认值:

{}

groups

public abstract String[] groups

The group to which the current operation belongs.

返回:

groups

默认值:

{}

propertyMappingStrategy

public abstract String propertyMappingStrategy

Get name of property mapping strategy.

返回:

strategy name

从以下版本开始:

2.1.0

另请参阅:

cn.crane4j.core.parser.handler.strategy.PropertyMappingStrategy

默认值:

""