de.smartics.properties.api.core.domain
Interface PropertyConstraint<T>

Type Parameters:

T - the type of the property value.

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractPropertyConstraint, GenericPropertyConstraint, ListValueConstraint, PropertyRangeConstraint

public interface PropertyConstraint<T>
     
     

      
      extends 
      
      Serializable
     
     

Defines constraints on a property value and a description to the constraint that can be presented to the user.

Method Summary

String	getDescription() Returns a description of the defined constraints.
String	getDescription(Locale locale) Returns a localized description of the defined constraints.
String	getViolationMessage(Locale locale, Object actualValue) Returns a localized description of the violation message adding the actual value.
boolean	isMandatoryConstraint() Determines if the constraint is a check that evaluates if a property is present or not and fails if a value is not present.
boolean	isValid(T value) Checks if the given value is valid for constraints in the default group.
boolean	isValid(T value, Class<?> group) Checks if the given value is valid only if the constraint is in the given group.
void	validate(PropertyDescriptor propertyDescriptor, T value) Checks if the given value is valid for constraints in the default group.
void	validate(PropertyDescriptor propertyDescriptor, T value, Class<?> group) Checks if the given value is valid.

Method Detail

isMandatoryConstraint

boolean isMandatoryConstraint()

Determines if the constraint is a check that evaluates if a property is present or not and fails if a value is not present.

Returns:

true if the constraint is a check for value presence, false if it is any regular constraint.

getDescription

String getDescription(Locale locale)

Returns a localized description of the defined constraints.

Parameters:

locale - the locale to use to fetch a localized description.

Returns:

a localized description of the defined constraints.

getDescription

String getDescription()

Returns a description of the defined constraints.

This is not the validation message that is displayed if the validation fails. This is a description of the constraints on a value that must be met to pass the validation process successfully. The description may be displayed to a user prior to request the input of a value.

Returns:

a description of the defined constraints.

getViolationMessage

String getViolationMessage(Locale locale,
                           Object actualValue)

Returns a localized description of the violation message adding the actual value.

Parameters:

locale - the locale to use for the message.

actualValue - the value that has violated the constraint.

Returns:

a localized description of violation message.

isValid

boolean isValid(T value)

Checks if the given value is valid for constraints in the default group.

Parameters:

value - the value to be checked.

Returns:

true if the value is valid, false otherwise.

isValid

boolean isValid(T value,
                Class<?> group)

Checks if the given value is valid only if the constraint is in the given group.

Parameters:

value - the value to be checked.

group - the validation only takes place if this constraint is in this group or the argument is null.

Returns:

true if the value is valid, false otherwise.

validate

void validate(PropertyDescriptor propertyDescriptor,
              T value)
              throws PropertyValidationException

Checks if the given value is valid for constraints in the default group.

Parameters:

propertyDescriptor - information about the name of the property to validate.

value - the value to be checked.

Throws:

PropertyValidationException - if the value is not valid.

validate

void validate(PropertyDescriptor propertyDescriptor,
              T value,
              Class<?> group)
              throws PropertyValidationException

Checks if the given value is valid.

Parameters:

propertyDescriptor - information about the name of the property to validate.

value - the value to be checked.

group - the validation only takes place if this constraint is in this group or the argument is null.

Throws:

PropertyValidationException - if the value is not valid.