Module rxmicro.validation

Package io.rxmicro.validation.constraint

Annotation Type MaxNumber

@Documented
@Retention(SOURCE)
@Target({FIELD,METHOD,PARAMETER})
@ConstraintRule(supportedTypes={java.math.BigDecimal.class,java.math.BigInteger.class,java.lang.Byte.class,java.lang.Short.class,java.lang.Integer.class,java.lang.Long.class,java.lang.Float.class,java.lang.Double.class},
                validatorClass={MaxBigDecimalNumberConstraintValidator.class,MaxBigIntegerNumberConstraintValidator.class,MaxByteConstraintValidator.class,MaxShortConstraintValidator.class,MaxIntConstraintValidator.class,MaxLongConstraintValidator.class,MaxFloatConstraintValidator.class,MaxDoubleConstraintValidator.class})
public @interface MaxNumber

The annotated element must be a number whose value must be lower or equal to the specified maximum.

Since:

0.1

Author:

nedis

See Also:

MaxInt, MaxDouble, Numeric, MaxBigDecimalNumberConstraintValidator, MaxBigIntegerNumberConstraintValidator, MaxByteConstraintValidator, MaxShortConstraintValidator, MaxIntConstraintValidator, MaxLongConstraintValidator, MaxFloatConstraintValidator, MaxDoubleConstraintValidator

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
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
boolean	inclusive	Specifies whether the specified maximum is inclusive or exclusive.
boolean	off	Allows disabling the validation rule if this rule is inherited from super class.

Element Detail

value

String value

The String representation of the max value according to the BigDecimal string representation.

Returns:

the value the element must be lower or equal to

off

boolean off

Allows disabling the validation rule if this rule is inherited from super class.

By default, disable is off.

Returns:

true if the validation must be disabled.

Default:

false

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

Default:

true