javax.validation.constraints.Digits Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of validation-api Show documentation

Bean Validation (JSR-303) API.

There is a newer version: 2.0.1.Final

// $Id: Digits.java 16368 2009-04-21 09:51:00Z epbernard $
/*
* JBoss, Home of Professional Open Source
* Copyright 2008, Red Hat Middleware LLC, and individual contributors
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* 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 javax.validation.constraints;

import java.lang.annotation.Documented;
import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import java.lang.annotation.Retention;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
import java.lang.annotation.Target;
import javax.validation.Constraint;

/**
 * The annotated element must be a number within accepted range
 * Supported types are:
 * 
 * BigDecimal
 * BigInteger
 * String
 * byte, short, int, long,
 * and their respective wrapper types
 * 
 * 
 * null elements are considered valid
 *
 * @author Emmanuel Bernard
 * @todo Is string supported or not?
 */
@Target({ METHOD, FIELD, ANNOTATION_TYPE })
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy = {})
public @interface Digits {
	String message() default "{constraint.digits}";

	Class[] groups() default { };

	/**
	 * @return maximum number of integral digits accepted for this number.
	 */
	int integer();

	/**
	 * @return maximum number of fractional digits accepted for this number.
	 */
	int fraction();

	/**
	 * Defines several @Digits annotations on the same element
	 * @see {@link Digits}
	 *
	 * @author Emmanuel Bernard
	 */
	@Target({ METHOD, FIELD, ANNOTATION_TYPE })
	@Retention(RUNTIME)
	@Documented
	@interface List {
		Digits[] value();
	}
}