Class LengthConstraint

  • All Implemented Interfaces:
    Serializable, Constraint

    public class LengthConstraint
    extends AbstractConstraint
    This constraints checks whether an object's String representation size is in some interval.

    This constraint's bounds are not strict (i.e. >= and <=).

    Since:
    7.1
    See Also:
    Serialized Form
    • Constructor Detail

      • LengthConstraint

        public LengthConstraint​(Object min,
                                Object max)
        For a fixed length, use min = max values.

        Bounds could be any object having toString representating an integer.

        Parameters:
        min - Minimum length for the validated String, use a null value to get unbounded length.
        max - Maximum length for the validated String, use a null value to get unbounded length.
    • 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()
        Here, value is :
        name = "LengthConstraint"
        parameters =
        • "Minimum" : 5 // only is bounded
        • "Maximum" : 10 // only if bounded
        Returns:
        The constraint description.
      • getMin

        public Long getMin()
        Returns:
        This constraints minimum length if bounded, null otherwise.
        Since:
        7.1
      • getMax

        public Long getMax()
        Returns:
        This constraints maximum length if bounded, null otherwise.
        Since:
        7.1
      • 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 interface Constraint
        Overrides:
        getErrorMessage in class AbstractConstraint
        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
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object