Constraints.java

/*
 *      Copyright (C) 2015 Noorq, Inc.
 *
 *   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 com.noorq.casser.mapping.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 javax.validation.Constraint;

import com.noorq.casser.mapping.validator.AlphabetValidator;
import com.noorq.casser.mapping.validator.EmailValidator;
import com.noorq.casser.mapping.validator.LengthValidator;
import com.noorq.casser.mapping.validator.LowerCaseValidator;
import com.noorq.casser.mapping.validator.MaxLengthValidator;
import com.noorq.casser.mapping.validator.MinLengthValidator;
import com.noorq.casser.mapping.validator.NotEmptyValidator;
import com.noorq.casser.mapping.validator.NotNullValidator;
import com.noorq.casser.mapping.validator.NumberValidator;
import com.noorq.casser.mapping.validator.PatternValidator;
import com.noorq.casser.mapping.validator.UpperCaseValidator;

/**
 * Constraint annotations are using for data integrity mostly for @java.lang.String types.  
 * The place of the annotation is the particular method in model interface.
 * 
 * All of them does not have effect on selects and data retrieval operations.
 * 
 * Support types: 
 * - @NotNull supports any @java.lang.Object type
 * - All annotations support @java.lang.String type
 * 
 * @author Albert Shift
 *
 */

public final class Constraints {

	private Constraints() {
	}

	/**
	 *  NotNull annotation is using to check that value is not null before storing it 
	 *  
	 *  Applicable to use in any @java.lang.Object
	 *  
	 *  It does not check on selects and data retrieval operations
     *
	 */
	
	@Documented
	@Retention(RetentionPolicy.RUNTIME)
	@Target(value = { ElementType.METHOD, ElementType.ANNOTATION_TYPE })
	@Constraint(validatedBy = NotNullValidator.class)
	public @interface NotNull {

	}
	
	/**
	 *  NotEmpty annotation is using to check that value has text before storing it 
	 *  
	 *  Also checks for the null and it is more strict annotation then @NotNull
	 *  
	 *  Can be used for @java.lang.CharSequence, @ByteBuffer and any array
	 *  
	 *  It does not check on selects and data retrieval operations
     *
	 */
	
	@Documented
	@Retention(RetentionPolicy.RUNTIME)
	@Target(value = { ElementType.METHOD, ElementType.ANNOTATION_TYPE })
	@Constraint(validatedBy = NotEmptyValidator.class)
	public @interface NotEmpty {
		
	}
	
	/**
	 *  Email annotation is using to check that value has a valid email before storing it 
	 *  
     *  Can be used only for @CharSequence
	 *  
	 *  It does not check on selects and data retrieval operations
     *
	 */
	
	@Documented
	@Retention(RetentionPolicy.RUNTIME)
	@Target(value = { ElementType.METHOD, ElementType.ANNOTATION_TYPE })
	@Constraint(validatedBy = EmailValidator.class)
	public @interface Email {

	}
	
	/**
	 *  Number annotation is using to check that all letters in value are digits before storing it 
	 *  
	 *  Can be used only for @java.lang.CharSequence
	 *  
	 *  It does not check on selects and data retrieval operations
     *
	 */
	
	@Documented
	@Retention(RetentionPolicy.RUNTIME)
	@Target(value = { ElementType.METHOD, ElementType.ANNOTATION_TYPE })
	@Constraint(validatedBy = NumberValidator.class)
	public @interface Number {

	}
	
	
	/**
	 *  Alphabet annotation is using to check that all letters in value are in specific alphabet before storing it 
	 *  
	 *  Can be used only for @java.lang.CharSequence
	 *  
	 *  It does not check on selects and data retrieval operations
     *
	 */
	
	@Documented
	@Retention(RetentionPolicy.RUNTIME)
	@Target(value = { ElementType.METHOD, ElementType.ANNOTATION_TYPE })
	@Constraint(validatedBy = AlphabetValidator.class)
	public @interface Alphabet {

		/**
		 * Defines alphabet that will be used to check value
		 * 
		 * @return alphabet characters in the string
		 */
		
		String value();
		
	}
	
	/**
	 *  Length annotation is using to ensure that value has exact length before storing it
	 *
	 *  Can be used for @java.lang.CharSequence, @ByteBuffer and any array
	 *
	 *  It does not have effect on selects and data retrieval operations
	 *
	 */
	
	@Documented
	@Retention(RetentionPolicy.RUNTIME)
	@Target(value = { ElementType.METHOD, ElementType.ANNOTATION_TYPE })
	@Constraint(validatedBy = LengthValidator.class)
	public @interface Length {

		int value();
		
	}
	
	/**
	 *  MaxLength annotation is using to ensure that value has length less or equal to some threshold before storing it
	 *
	 *  Can be used for @java.lang.CharSequence, @ByteBuffer and byte[]
	 *
	 *  It does not have effect on selects and data retrieval operations
	 *
	 */
	
	@Documented
	@Retention(RetentionPolicy.RUNTIME)
	@Target(value = { ElementType.METHOD, ElementType.ANNOTATION_TYPE })
	@Constraint(validatedBy = MaxLengthValidator.class)
	public @interface MaxLength {

		int value();
		
	}
	
	/**
	 *  MinLength annotation is using to ensure that value has length greater or equal to some threshold before storing it
	 *
	 *  Can be used for @java.lang.CharSequence, @ByteBuffer and byte[]
	 *
	 *  It does not have effect on selects and data retrieval operations
	 *
	 */
	
	@Documented
	@Retention(RetentionPolicy.RUNTIME)
	@Target(value = { ElementType.METHOD, ElementType.ANNOTATION_TYPE })
	@Constraint(validatedBy = MinLengthValidator.class)
	public @interface MinLength {

		int value();
		
	}
	
	/**
	 *  LowerCase annotation is using to ensure that value is in lower case before storing it
	 *
	 *  Can be used only for @java.lang.CharSequence
	 *
	 *  It does not have effect on selects and data retrieval operations
	 *
	 */		
	
	@Documented
	@Retention(RetentionPolicy.RUNTIME)
	@Target(value = { ElementType.METHOD, ElementType.ANNOTATION_TYPE })
	@Constraint(validatedBy = LowerCaseValidator.class)
	public @interface LowerCase {

	}

	/**
	 *  UpperCase annotation is using to ensure that value is in upper case before storing it
	 *
	 *  Can be used only for @java.lang.CharSequence
	 *
	 *  It does not have effect on selects and data retrieval operations
	 *
	 */	
	
	@Documented
	@Retention(RetentionPolicy.RUNTIME)
	@Target(value = { ElementType.METHOD, ElementType.ANNOTATION_TYPE })
	@Constraint(validatedBy = UpperCaseValidator.class)
	public @interface UpperCase {

	}
	
	/**
	 *  Pattern annotation is LowerCase annotation is using to ensure that value is upper case before storing it
	 *
	 *  Can be used only for @java.lang.CharSequence
	 *
	 *  It does not have effect on selects and data retrieval operations
	 *
	 */	
	
	@Documented
	@Retention(RetentionPolicy.RUNTIME)
	@Target(value = { ElementType.METHOD, ElementType.ANNOTATION_TYPE })
	@Constraint(validatedBy = PatternValidator.class)
	public @interface Pattern {

		/**
		 * User defined regex expression to check match of the value
		 * 
		 * @return Java regex pattern
		 */
		
		String value();
		
		/**
		 * Regex flags composition
		 * 
		 * @return Java regex flags
		 */
		
		int flags();
		
	}
	
}