cn.crane4j.annotation.AssembleEnum Maven / Gradle / Ivy
package cn.crane4j.annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Declare an operation of assemble based on enum container.
*
* @author huangchengxing
* @see cn.crane4j.core.parser.TypeHierarchyBeanOperationParser;
* @see cn.crane4j.core.parser.handler.AssembleEnumAnnotationHandler;
* @see 1.3.0
*/
@Repeatable(value = AssembleEnum.List.class)
@Documented
@Target({ElementType.ANNOTATION_TYPE, ElementType.FIELD, ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface AssembleEnum {
/**
* Enum class.
*
* @return enum class
*/
Class type() default Object.class;
/**
* Full class name of enum class,
* only valid when {@link #type()} is {@link Void} or {@link Object}.
*
* @return full class name
* @since 2.2.0
*/
String typeName() default "";
/**
* Configuration of container.
*
* @return {@link ContainerEnum} annotation.
* @since 2.4.0
*/
ContainerEnum enums() default @ContainerEnum;
/**
* a quick set for reference field name, equivalent to {@code @Mapping(ref = "")}.
* when not empty, the value is jointly effective with {@link #props()}.
*
* @return reference field name
* @see #props()
*/
String ref() default "";
/**
* If the {@link #type()} is annotated with {@link ContainerEnum},
* the configuration defined by that annotation will be used first.
*
* @return boolean
* @since 2.4.0
*/
boolean followTypeConfig() default true;
// ================= common =================
/**
*
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.
*
*
*
* @return field name of key
*/
String key() default "";
/**
* 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 {@link Long} type,
* and the key value corresponding to the current operation is {@link Integer},
* then the {@code keyType} needs to be {@link Long} at this time.
* When the actual operation is performed,
* the key value is automatically converted from Integer to {@link Long} type.
*
* @return key type
* @since 2.2.0
*/
Class keyType() default Object.class;
/**
* Sort values.
* The lower the value, the higher the priority.
*
* @return sort values
*/
int sort() default Integer.MAX_VALUE;
/**
* The name of the handler to be used.
*
* @return name
* @see cn.crane4j.core.executor.handler.AssembleOperationHandler;
*/
String handler() default "";
/**
* The type of the handler to be used.
*
* @return name
* @see cn.crane4j.core.executor.handler.AssembleOperationHandler;
*/
Class handlerType() default Object.class;
/**
* Attributes that need to be mapped
* between the data source object and the current object.
*
* @return attributes
* @see #propTemplates()
*/
Mapping[] props() default { };
/**
*
Mapping template classes.
* specify a class, if {@link MappingTemplate} exists on the class,
* it will scan and add {@link Mapping} to {@link #props()}。
*
* @return mapping templates
*/
Class[] propTemplates() default {};
/**
* The group to which the current operation belongs.
*
* @return groups
*/
String[] groups() default {};
/**
* Get name of property mapping strategy.
*
* @return strategy name
* @see cn.crane4j.core.parser.handler.strategy.PropertyMappingStrategy
* @since 2.1.0
*/
String propertyMappingStrategy() default "";
/**
* Batch operation.
*
* @author huangchengxing
*/
@Documented
@Target({ElementType.ANNOTATION_TYPE, ElementType.FIELD, ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface List {
AssembleEnum[] value() default {};
}
}