Class EnumConstraint
- java.lang.Object
-
- org.nuxeo.ecm.core.schema.types.constraints.AbstractConstraint
-
- org.nuxeo.ecm.core.schema.types.constraints.EnumConstraint
-
- All Implemented Interfaces:
Serializable
,Constraint
public class EnumConstraint extends AbstractConstraint
This constraint ensures some object's String representation is in an enumeration.
- Since:
- 7.1
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.nuxeo.ecm.core.schema.types.constraints.Constraint
Constraint.Description
-
-
Field Summary
Fields Modifier and Type Field Description protected Set<String>
possibleValues
-
Fields inherited from interface org.nuxeo.ecm.core.schema.types.constraints.Constraint
MESSAGES_BUNDLE, MESSAGES_DEFAULT_LANG, MESSAGES_KEY
-
-
Constructor Summary
Constructors Constructor Description EnumConstraint(Object... possibleValues)
EnumConstraint(List<?> possibleValues)
Supports any objects, use their String representation.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object obj)
Constraint.Description
getDescription()
String
getErrorMessage(Object invalidValue, Locale locale)
Provides an error message to display when some invalid value does not match existing entity.Set<String>
getPossibleValues()
int
hashCode()
boolean
validate(Object object)
Validates the given object against this constraint.-
Methods inherited from class org.nuxeo.ecm.core.schema.types.constraints.AbstractConstraint
getMessageKey, getMessageString, toString
-
-
-
-
Field Detail
-
possibleValues
protected final Set<String> possibleValues
-
-
Constructor Detail
-
EnumConstraint
public EnumConstraint(List<?> possibleValues)
Supports any objects, use their String representation.
-
EnumConstraint
public EnumConstraint(Object... possibleValues)
-
-
Method Detail
-
validate
public boolean validate(Object object)
Description copied from interface:Constraint
Validates the given object against this constraint.If some object is null. Constraint should return true while validating unless the constraint deals with nullable state.
- Parameters:
object
- the object to validate- Returns:
- true if the object was successfully validated, false otherwise
-
getDescription
public Constraint.Description getDescription()
- Returns:
- The constraint description.
-
getPossibleValues
public Set<String> getPossibleValues()
-
getErrorMessage
public String getErrorMessage(Object invalidValue, Locale locale)
Description copied from interface:Constraint
Provides an error message to display when some invalid value does not match existing entity.- Specified by:
getErrorMessage
in interfaceConstraint
- Overrides:
getErrorMessage
in classAbstractConstraint
- Parameters:
invalidValue
- The invalid value that don't match any entity.locale
- The language in which the message should be generated.- Returns:
- A message in the specified language or
-
-