com.yuehuanghun.mybatis.milu.annotation.AttributeOptions Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mybatis-milu Show documentation

A mybatis orm enhance framework.

There is a newer version: 1.18.0

/*
 * Copyright 2020-2022 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.yuehuanghun.mybatis.milu.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 org.apache.ibatis.type.JdbcType;
import org.apache.ibatis.type.TypeHandler;

/**
 * 字段配置
 * @author yuehuanghun
 *
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.METHOD, ElementType.ANNOTATION_TYPE})
public @interface AttributeOptions {

	/**
	 * 仅可设置一个元素
	 * @return 条件设置
	 */
	ExampleQuery[] exampleQuery() default {};
	
	/**
	 * 设置属性值自动填充器，仅可设置一个元素
	 * @return 自动填充设置
	 */
	Filler[] filler() default {};
	
	/**
	 * 作为更新字段时，值为何种情况生效
	 * @return 更新模式
	 */
	Mode updateMode() default Mode.AUTO;
	
	/**
	 * 作为查询条件时，值为何种情况时生效
	 * @return 条件模式
	 */
	Mode conditionMode() default Mode.AUTO;
	
	/**
	 * 设置类型处理器
	 * @return 类型处理器, 最多一个元素有效
	 */
	Class>[] typeHandler() default {};
	
	/**
	 * JDBC类型，一般自动识别
	 * @return 最多一个元素有效
	 */
	JdbcType[] jdbcType() default {};
	
	/**
	 * 逻辑删除声明
	 * @return 逻辑删除设置
	 */
	LogicDelete[] logicDelete() default {};
}