Module rxmicro.validation

Package io.rxmicro.validation.constraint

Annotation Type SubEnum

@Documented
@Retention(SOURCE)
@Target({FIELD,METHOD,PARAMETER})
@ConstraintRule(supportedTypes=java.lang.Enum.class,
                validatorClass=SubEnumConstraintValidator.class)
@SelfDocumented
public @interface SubEnum

The annotated element must be an enumeration with predefined sub sequence.

Since:

0.1

Author:

nedis

See Also:

Enumeration, Enum, SubEnumConstraintValidator

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String[]	exclude	Only not exclude values allowed.
String[]	include	Only include values allowed.
boolean	off	Allows disabling the validation rule if this rule is inherited from super class.

Element Detail

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

include

String[] include

Only include values allowed.

'include' has more priority, so if 'include' and 'exclude' are defined, 'exclude' will be ignored.

Returns:

the include enum names

See Also:

exclude()

Default:

{}

exclude

String[] exclude

Only not exclude values allowed.

Returns:

the exclude enum names

See Also:

include()

Default:

{}