com.github.ldeitos.constraint.DecimalMax Maven / Gradle / Ivy

Go to download
package com.github.ldeitos.constraint;

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;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import javax.validation.Constraint;
import javax.validation.Payload;

import com.github.ldeitos.validators.MaxDecimalValidator;

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

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

    String message() default "{javax.validation.constraints.DecimalMax.message}";

    /**
     * @return Parameter array to be interpolated at message. Parameters can be informed in
     * "key=value" or just "value" pattern.

     * e.g:

     * 

     * message="My {par1} message"

     * messageParameters = {"par1=parameterized"}

     * 

     * message="My {0} message"

     * messageParameters = {"parameterized"}
     */
    String[] messageParameters() default {};
    
    Class[] groups() default { };

    Class[] 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 minimum,
     *         {@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();
    }
}