Package org.carrot2.util.attribute.constraint

Constraints that can be imposed on attributes provided for Carrot² components.

See:
Description

Interface Summary

IValueHintMapping

This interface provides secondary mapping between enum constants, user-interface (user-friendly) names and attribute values.

Class Summary

Constraint	A base class for implementing constraints.
ConstraintFactory	Builds constraint implementation from constraint annotations.
ConstraintValidator	Checks whether values meet the provided constraints.
PassesValueOfConstraint
ValueHintEnumConstraint
ValueHintMappingUtils	Utilities for dealing with IValueHintMapping and Enum classes.

Exception Summary

ConstraintViolationException

An exception thrown when an attempt is made to bind attribute values that do not meet the constraints.

Annotation Types Summary

DoubleRange	Requires that the double attribute value is between DoubleRange.min() (inclusively) and DoubleRange.max() (inclusively).
ImplementingClasses	Requires that instances bound to the attribute are of one of the provided ImplementingClasses.classes().
IntModulo	Requires that the integer attribute value meets the condition: attributeValue % IntModulo.modulo() == IntModulo.offset().
IntRange	Requires that the integer attribute value is between IntRange.min() (inclusively) and IntRange.max() (inclusively).
IsConstraint	Marks annotations as annotation constraints.
IsDirectory	Requires that the File object is a directory.
IsFile	Requires that the provided object is an instance of File and the path denoted by it is actually a file.
NotBlank	Requires that the CharSequence value is not blank, i.e.
PassesValueOf	Requires that instances bound to the attribute are a valid result of the attribute's class static valueOf method.
ResourceNameFilter	A single resource filter (pattern and description).
ResourceNameFilters	A resource name filter (not a constraint, just a hint for editors).
ValueHintEnum	A set of values for an attribute of type String.

Package org.carrot2.util.attribute.constraint Description

Constraints that can be imposed on attributes provided for Carrot² components.