gu.sql2java.wherehelper.annotations.Compare Maven / Gradle / Ivy

Go to download
package gu.sql2java.wherehelper.annotations;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import gu.sql2java.wherehelper.CompareOp;
import gu.sql2java.wherehelper.VarTestType;

import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.ElementType;
import java.lang.annotation.Repeatable;

/**
 * WhereHelper 算术比较表达式注解
 * @author guyadong
 * @since 3.25.0
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD,ElementType.TYPE})
@Documented
@Repeatable(Compares.class)
public @interface Compare{
	/**
	 * test表达式执行为true时生成的算述比较表达式
	 */
	String test() default "true";
	/**
	 * 要求为null的变量名列表,['var1','var2'],等价于'null==${var1} && null==${var2}',为空则默认为'true'
	 */
	String[] testNullVars() default{};
	/**
	 * 要求不为null的变量名列表,['var1','var2'],等价于'null!=${var1} && null!=${var2}',为空则默认为'true'
	 */
	String[] testNonullVars() default{};
	/**
	 * 要求为{@code null}或空的变量名列表,['var1','var2'],等价于'isEmpty(${var1}) && isEmpty(${var2})',为空则默认为'true'
	 */
	String[] testEmptyVars() default{};
	/**
	 * 要求不为{@code null}或空的变量名列表,['var1','var2'],等价于!'isEmpty(${var1}) && !isEmpty(${var2})',为空则默认为'true'
	 */
	String[] testNoEmptyVars() default{};
	/**
	 * 要求为{@code true}的变量名列表,['var1','var2'],等价于'isTrue(${var1)} && isTrue(${var2})',为空则默认为'true'
	 */
	String[] testTrueVars() default{};
	/**
	 * 要求为{@code false}的变量名列表,['var1','var2'],等价于'isFalse(${var1}) && isFalse(${var2})',为空则默认为'true'
	 */
	String[] testFalseVars() default{};
	/**
	 * 定义基于{@link #testType()}的条件测试表达式变量名
	 */
	String testVar() default "";
	/**
	 * 变量测试类型
	 */
	VarTestType testType() default VarTestType.EQUAL;
	/**
	 * 条件测试操作符
	 */
	CompareOp testOp() default CompareOp.EQ ;
	/**
	 * 变量条件测试的目标值 
	 */
	String testValue() default "";
	/**
	 * 为{@code true}生成表达式对{@link #testValue()} 以字符串对头尾增加单引号,
	 * {@link #testRefValue()}为{@code true}时忽略
	 */
	boolean testQuote() default false;
	/**
	 * 为{@code true}生成表达式对{@link #testValue()} 视为变量名
	 */
	boolean testRefValue() default false;
	/**
	 * 执行算术比较的字段名
	 */
	String value() default "";
	/**
     *  算术比较表达式的左侧字段名
     */
    String left() default "";
	/**
	 *执行算术比较运算符
	 */
    CompareOp op() default CompareOp.EQ;
    /**
     * 为{@code true}生成表达式对数值以字符串对象头尾增加单引号
     */
    boolean quote() default false;
	/**
	 * 为{@code true}生成SQL表达式对{@link #value()} 视为变量名
	 */
	boolean refValue() default true;
    /**
     * 是否对{@link #value()}指定的变量执行判断空检查

     * 
     * {@code true} --{@link #value()}指定的变量执行判断空检查
     * {@code false} -- 只需要判断是否为{@code null},此参数对于类型为String的参数有影响
     * 空                  -- 使用{@link #quote()}
     * 
     */
    boolean[] checkFieldEmpty() default {};
}