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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.liveSense.misc.gwt.jsr303 Show documentation
liveSense JSR 303 GWT client Bean Validation
The newest version!
// $Id: DecimalMax.java 17620 2009-10-04 19:19:28Z hardy.ferentschik $
/*
* JBoss, Home of Professional Open Source
* Copyright 2009, Red Hat, Inc. and/or its affiliates, 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 java.lang.annotation.Retention;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
import java.lang.annotation.Target;
import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.ElementType.PARAMETER;
import javax.validation.Constraint;
import javax.validation.Payload;

/**
 * The annotated element must be a number whose value must be lower or
 * equal to the specified maximum.
 * 
 * Supported types are:
 * 

 * BigDecimal
 * BigInteger
 * String
 * byte, short, int, long,
 * and their respective wrappers
 * 
 * Note that double and float are not supported due to rounding errors
 * (some providers might provide some approximative support)
 * 
 * null elements are considered valid.
 *
 * @author Emmanuel Bernard
 */
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER })
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy = { })
public @interface DecimalMax {
	String message() default "{javax.validation.constraints.DecimalMax.message}";

	Class[] groups() default { };

	Class[] payload() default {};

	/**
	 * The String representation of the max value according to the
	 * BigDecimal string representation
	 *
	 * @return value the element must be lower or equal to
	 */
	String value();

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