Annotation Type DecimalMax


  • @Target({METHOD,FIELD,ANNOTATION_TYPE,CONSTRUCTOR,PARAMETER,TYPE_USE})
    @Retention(RUNTIME)
    @Repeatable(List.class)
    @Documented
    @Constraint(validatedBy={})
    public @interface DecimalMax
    The annotated element must be a number whose value must be lower or equal to the specified maximum.

    Supported types are:

    • BigDecimal
    • BigInteger
    • CharSequence
    • 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
    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String value
      The String representation of the max value according to the BigDecimal string representation.
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.Class<?>[] groups  
      boolean inclusive
      Specifies whether the specified maximum is inclusive or exclusive.
      java.lang.String message  
      java.lang.Class<? extends Payload>[] payload  
    • Element Detail

      • value

        java.lang.String value
        The String representation of the max value according to the BigDecimal string representation.
        Returns:
        value the element must be lower or equal to
      • message

        java.lang.String message
        Default:
        "{jakarta.validation.constraints.DecimalMax.message}"
      • groups

        java.lang.Class<?>[] groups
        Default:
        {}
      • payload

        java.lang.Class<? extends Payload>[] payload
        Default:
        {}
      • inclusive

        boolean inclusive
        Specifies whether the specified maximum is inclusive or exclusive. By default, it is inclusive.
        Returns:
        true if the value must be lower or equal to the specified maximum, false if the value must be lower
        Since:
        1.1
        Default:
        true