cn.crane4j.annotation

注释类型 ContainerMethod

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

Indicates that the annotation or the method pointed to by the annotation can be converted to a method container of the specified type. The annotated method needs to meet the following requirements：

• method must have a return value;
• If type() is MappingType.NO_MAPPING, the return value type must be Map;
• If type() is not MappingType.NO_MAPPING, the return value can be a single object, array or Collection;

For example, the following example describes how to adapt the requestFoo() method to a data source container：
The first way is to add annotations directly on the method：

{@code

作者:

huangchengxing

另请参阅:

cn.crane4j.core.support.container.DefaultMethodContainerFactory, cn.crane4j.core.support.container.ContainerMethodAnnotationProcessor

可选元素概要

可选元素

限定符和类型	可选元素和说明
String	bindMethod The name of method which will be used to adapt the method container.
Class<?>[]	bindMethodParamTypes The parameter types of the method which will be used to adapt the method container.
DuplicateStrategy	duplicateStrategy The strategy for handling duplicate keys.
String	namespace Namespace of the data source container, use method name when empty.
String	on When the return value is a wrapper class, we can specify to obtain the dataset to be processed from the specific field of the wrapper class, and then use it to be data source of the container.
String	resultKey The key field of the data source object returned by the method.
Class<?>	resultType Data source object type returned by method.
MappingType	type The mapping relationship between the object returned by the method and the target object.

元素详细资料

namespace

public abstract String namespace

Namespace of the data source container, use method name when empty.

返回:

namespace

默认值:

""

type

public abstract MappingType type

The mapping relationship between the object returned by the method and the target object.

返回:

mapping relationship

默认值:

cn.crane4j.annotation.MappingType.ONE_TO_ONE

duplicateStrategy

public abstract DuplicateStrategy duplicateStrategy

The strategy for handling duplicate keys.

返回:

strategy

从以下版本开始:

2.2.0

默认值:

cn.crane4j.annotation.DuplicateStrategy.ALERT

resultKey

public abstract String resultKey

The key field of the data source object returned by the method.
If type() is MappingType.NO_MAPPING or MappingType.ORDER_OF_KEYS, this parameter is ignored.

返回:

key field name

默认值:

"id"

resultType

public abstract Class<?> resultType

Data source object type returned by method.
If type() is MappingType.NO_MAPPING or MappingType.ORDER_OF_KEYS, this parameter is ignored.

返回:

type

默认值:

java.lang.Void.class

bindMethod

public abstract String bindMethod

The name of method which will be used to adapt the method container.
If annotation is annotated on the method, this parameter is ignored.

返回:

method name, if empty, find method by namespace()

默认值:

""

bindMethodParamTypes

public abstract Class<?>[] bindMethodParamTypes

The parameter types of the method which will be used to adapt the method container.
If annotation is annotated on the method, this parameter is ignored.

返回:

parameter types

默认值:

{}

on

public abstract String on

When the return value is a wrapper class, we can specify to obtain the dataset to be processed from the specific field of the wrapper class, and then use it to be data source of the container.

For example:

// general response
 public static class Result {
     private Integer code;
     private T data; // objects to be processed
 }
 // process general response

返回:

field name

从以下版本开始:

2.8.0

另请参阅:

AutoOperate.on()

默认值:

""