com.yuehuanghun.mybatis.milu.annotation.LogicDelete 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

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 com.yuehuanghun.mybatis.milu.tool.logicdel.LogicDeleteProvider;

/**
 * 逻辑删除声明

 * 作为AttributeOptions的属性注解在实体类属性上或者直接注解在实体类属性上

 * 允许声明在实体类的多个属性上
 * 
 * @see com.yuehuanghun.mybatis.milu.annotation.AttributeOptions
 * @see com.yuehuanghun.mybatis.milu.BaseMapper#logicDeleteById
 * @author yuehuanghun
 *
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.ANNOTATION_TYPE, ElementType.FIELD})
public @interface LogicDelete {

	/**
	 * 逻辑删除时设置的值
	 * @see com.yuehuanghun.mybatis.milu.BaseMapper#logicDeleteById
	 * @return 值
	 */
	String value() default "1";
	
	/**
	 * 恢复正常状态时的值

	 * @see com.yuehuanghun.mybatis.milu.BaseMapper#resumeLogicDeletedById
	 * @return 值
	 */
	String resumeValue() default "0";
	
	/**
	 * 值为LogicDeleteProvider.AutoProvider时，则以注释属性的value()与resumeValue为准
	 * @return LogicDeleteProvider实现类
	 */
	Class provider() default LogicDeleteProvider.AutoProvider.class;
	
	/**
	 * 主逻辑删除属性

	 * 在Criteria查询中，使用undeleted()或deleted()设定查询条件时，当为主删除属性时才会被用于查询条件中

	 * 举例：获取未被逻辑删除的数据：someMapper.findByCriteria(p -> p.undeleted());
	 * @return true/false
	 */
	boolean main() default true;
}