/*
* JBoss, Home of Professional Open Source
* Copyright 2009-2013, 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 java.lang.annotation.
Target;
import javax.validation.
Constraint;
import javax.validation.
Payload;
import static java.lang.annotation.
ElementType.
ANNOTATION_TYPE;
import static java.lang.annotation.
ElementType.
CONSTRUCTOR;
import static java.lang.annotation.
ElementType.
FIELD;
import static java.lang.annotation.
ElementType.
METHOD;
import static java.lang.annotation.
ElementType.
PARAMETER;
import static java.lang.annotation.
RetentionPolicy.
RUNTIME;
/**
* The annotated element must be a number whose value must be lower or
* equal to the specified maximum.
* <p/>
* Supported types are:
* <ul>
* <li>{@code BigDecimal}</li>
* <li>{@code BigInteger}</li>
* <li>{@code CharSequence}</li>
* <li>{@code byte}, {@code short}, {@code int}, {@code long}, and their respective
* wrappers</li>
* </ul>
* Note that {@code double} and {@code float} are not supported due to rounding errors
* (some providers might provide some approximative support).
* <p/>
* {@code 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<? extends
Payload>[] payload() default { };
/**
* The {@code String} representation of the max value according to the
* {@code BigDecimal} string representation.
*
* @return value the element must be lower or equal to
*/
String value();
/**
* Specifies whether the specified maximum is inclusive or exclusive.
* By default, it is inclusive.
*
* @return {@code true} if the value must be lower or equal to the specified maximum,
* {@code false} if the value must be lower
*
* @since 1.1
*/
boolean inclusive() default true;
/**
* Defines several {@link DecimalMax} annotations on the same element.
*
* @see DecimalMax
*/
@
Target({
METHOD,
FIELD,
ANNOTATION_TYPE,
CONSTRUCTOR,
PARAMETER })
@
Retention(
RUNTIME)
@
Documented
@interface
List {
DecimalMax[] value();
}
}