org.yx.annotation.db.SoftDelete Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sumk Show documentation

A quick developing framewort for internet company

There is a newer version: 4.0.2

/**
 * Copyright (C) 2016 - 2030 youtongluan.
 *
 * 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
 *
 * 		http://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 org.yx.annotation.db;

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.yx.db.enums.ValidRecord;

/**
 * 有这个标志，就说明是软删除

 * 支持pojo中存在与软删除同名的字段（大小写不敏感），通常只在whatIsValid 这时insert和udpate的时候，要注意该字段的状态位。
 * 
 * @author 游夏
 *
 */
@Target({ ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface SoftDelete {

	/**
	 * @return 数据库中字段的名字
	 */
	String value();

	/**
	 * @return 只能是String、Integer、Byte、Short、Long、Boolean或者它们的原始类型
	 */
	Class type() default String.class;

	/**
	 * @return 如果是数字类型，会被转化成数字类型

	 *         如果是Boolean类型，这个属性没有意义
	 * 
	 */
	String validValue() default "1";

	/**
	 * @return 如果是数字类型，会被转化成数字类型

	 *         如果是Boolean类型，这个属性没有意义
	 * 
	 */
	String inValidValue() default "0";

	ValidRecord whatIsValid() default ValidRecord.EQUAL_VALID;
}