cn.crane4j.annotation.AutoOperate Maven / Gradle / Ivy
package cn.crane4j.annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.lang.reflect.AnnotatedElement;
/**
* Mark a {@link AnnotatedElement} to indicate that
* after a specific step, the instance corresponding to the element
* will automatically complete the filling operation.
*
*
For example, mark it on a method to indicate that
* its return value needs to be automatic filling after a method call,
* or mark it on a class to indicate that
* automatic filling is required during its serialization.
*
* @author huangchengxing
* @see ArgAutoOperate
* @see cn.crane4j.core.support.auto.AutoOperateAnnotatedElement
* @see cn.crane4j.core.support.auto.AutoOperateAnnotatedElementResolver
*/
@Target({ElementType.METHOD, ElementType.PARAMETER, ElementType.ANNOTATION_TYPE, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface AutoOperate {
/**
* When used in {@link ArgAutoOperate}, it is used to bind the corresponding parameter name.
*
* @return parameter name
*/
String value() default "";
/**
*
The object type to be processed in the return value of the method.
* It will be parsed by the parser specified in {@link #parser()} when it is first executed,
* and then the operation configuration will be obtained.
*
*
If the object is generic or cannot be confirmed, the default value is {@link Object},
* and the type will be automatically inferred.
*
* @return type to be processed
* @see cn.crane4j.core.support.TypeResolver
*/
Class type() default Object.class;
/**
*
When the return value is a wrapper class,
* we can specify to obtain the data set to be processed
* from the specific field of the wrapper class, and then process it。
*
*
This configuration is generally used to process the method
* of returning the general response body in the Controller。
* For example:
*
{@code
* // general response
* public static class Result {
* private Integer code;
* private T data; // objects to be processed
* }
* // process general response
* @AutoOperate(type = Foo.class, on = "data")
* public Result requestFoo() { // do something }
* }
* The return value of the method isResult, but the data to be filled is in Result.data,
* obtain data from specific fields for filling by on.
*
* @return field name
*/
String on() default "";
/**
* The name of the executor to be used.
*
* @return executor name
* @see cn.crane4j.core.executor.BeanOperationExecutor
*/
String executor() default "";
/**
* The type of the executor to be used.
*
* @return executor name
* @see cn.crane4j.core.executor.BeanOperationExecutor
*/
Class executorType() default Object.class;
/**
* The name of the operation parser to be used.
*
* @return parser name
* @see cn.crane4j.core.parser.BeanOperationParser
*/
String parser() default "";
/**
* The type of the operation parser to be used.
*
* @return parser name
* @see cn.crane4j.core.parser.BeanOperationParser
*/
Class parserType() default Object.class;
/**
* The group of operations to be performed.
* If it is blank, all operations will be performed by default.
*
* @return group names
*/
String[] includes() default {};
/**
* The group of operations not to be performed.
* The priority of this configuration is higher than {@link #includes()}
*
* @return group names
*/
String[] excludes() default {};
/**
*
The expression of apply condition.
* The operation will only be performed when the expression result is {@code true} or "true" string。
*
*
The following variables can be used by default in the expression：
*
* - {@code @beanName}：beans in spring context；
* - {@code #parameterName}: arguments of method；
* - {@code #result}: return value of method；
*
*
* @return expression of apply condition
*/
String condition() default "";
}