cn.crane4j.annotation

注释类型 AssembleMethod

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

Declare an operation of assemble based on method container.

从以下版本开始:

2.2.0

作者:

huangchengxing

另请参阅:

ContainerMethod, cn.crane4j.core.parser.TypeHierarchyBeanOperationParser;, cn.crane4j.core.parser.handler.AssembleMethodAnnotationHandler;

必需元素概要

所需元素

限定符和类型	必需的元素和说明
ContainerMethod	method The method which will be used to obtain the data source object.

可选元素概要

可选元素

限定符和类型	可选元素和说明
ContainerCache	cache Cache configuration, it will be used only when enableCache() is false.
boolean	enableCache Whether to use the cache configuration of cache().
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	id Operation id.
String	key key field name.
String	keyDesc Some description of the key which helps resolver to resolve the key.
Class<?>	keyResolver The name of key resolver to be used.
Class<?>	keyType The type to which the key value of target should be converted when fetching the data source from the data source.
String[]	prop Attributes that need to be mapped between the data source object and the current object.
String	propertyMappingStrategy Get the 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.
int	sort Sort values.
String	target Bean name, or Fully qualified name of target class
Class<?>	targetType Class of target.

元素详细资料

method

public abstract ContainerMethod method

The method which will be used to obtain the data source object.

返回:

annotation

targetType

public abstract Class<?> targetType

Class of target.

返回:

class

默认值:

java.lang.Object.class

target

public abstract String target

Bean name, or Fully qualified name of target class

返回:

class full name

默认值:

""

enableCache

public abstract boolean enableCache

Whether to use the cache configuration of cache().
If target method is already specified the cache configuration, this configuration will be ignored.

返回:

true if follow method cache config, otherwise false

从以下版本开始:

2.6.0

默认值:

false

cache

public abstract ContainerCache cache

Cache configuration, it will be used only when enableCache() is false.

返回:

cache

从以下版本开始:

2.6.0

另请参阅:

enableCache()

默认值:

@cn.crane4j.annotation.ContainerCache

id

public abstract String id

Operation id.

返回:

id

从以下版本开始:

2.6.0

默认值:

""

key

public abstract String key

key field name.
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.

返回:

key field name

默认值:

""

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

keyResolver

public abstract Class<?> keyResolver

The name of key resolver to be used.

返回:

namespace

从以下版本开始:

2.7.0

默认值:

java.lang.Object.class

keyDesc

public abstract String keyDesc

Some description of the key which helps resolver to resolve the key.

返回:

description

从以下版本开始:

2.7.0

默认值:

""

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.
It equivalent to prop().

返回:

attribute mappings

另请参阅:

propTemplates()

默认值:

{}

prop

public abstract String[] prop

Attributes that need to be mapped between the data source object and the current object.
It equivalent to props().

the format is following:

• 'a:b'：equivalent to @Mapping(src = 'a', ref = 'b')；
• 'a'：equivalent to @Mapping(src = 'a', ref = 'a') or @Mapping('a')；
• ':a'：equivalent to @Mapping(ref = 'a')；
• 'a:'：equivalent to @Mapping(src = 'a')；

返回:

attribute mappings

从以下版本开始:

2.7.0

默认值:

{}

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 the name of property mapping strategy.

返回:

strategy name

从以下版本开始:

2.1.0

另请参阅:

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

默认值:

""