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;, 1.3.0

可选元素概要

可选元素

限定符和类型	可选元素和说明
ContainerEnum	enums Configuration of container.
boolean	followTypeConfig If the type() is annotated with ContainerEnum, the configuration defined by that annotation will be used first.
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.
Class<?>	keyType The type to which the key value of target should be converted when fetching the data source from the data source.
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.
Class<?>	type Enum class.
String	typeName Full class name of enum class, only valid when type() is Void or Object.

元素详细资料

type

public abstract Class<?> type

Enum class.

返回:

enum class

默认值:

java.lang.Object.class

typeName

public abstract String typeName

Full class name of enum class, only valid when type() is Void or Object.

返回:

full class name

从以下版本开始:

2.2.0

默认值:

""

enums

public abstract ContainerEnum enums

Configuration of container.

返回:

ContainerEnum annotation.

从以下版本开始:

2.4.0

默认值:

@cn.crane4j.annotation.ContainerEnum

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()

默认值:

""

followTypeConfig

public abstract boolean followTypeConfig

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

返回:

boolean

从以下版本开始:

2.4.0

默认值:

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

默认值:

""

keyType

public abstract Class<?> keyType

The type to which the key value of target should be converted when fetching the data source from the data source.

For example, the data source obtained from the data source is grouped according to the key of the Long type, and the key value corresponding to the current operation is Integer, then the keyType needs to be Long at this time.
When the actual operation is performed, the key value is automatically converted from Integer to Long type.

返回:

key type

从以下版本开始:

2.2.0

默认值:

java.lang.Object.class

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

默认值:

""