griffon.plugins.validation.constraints

Interface Constraint

All Known Subinterfaces:

VetoingConstraint

All Known Implementing Classes:

AbstractConstraint, AbstractVetoingConstraint, BlankConstraint, CreditCardConstraint, DateConstraint, EmailConstraint, InListConstraint, MatchesConstraint, MaxConstraint, MaxSizeConstraint, MinConstraint, MinSizeConstraint, NotEqualConstraint, NullableConstraint, RangeConstraint, ScaleConstraint, SizeConstraint, UrlConstraint, ValidatorConstraint

public interface Constraint

Defines a validatable constraint.

Author:

Graeme Rocher (Grails)

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXCEEDED_SUFFIX
static String	INVALID_SUFFIX
static String	NOT_PREFIX
static String	NOTMET_SUFFIX
static String	TOOBIG_SUFFIX
static String	TOOLONG_SUFFIX
static String	TOOSHORT_SUFFIX
static String	TOOSMALL_SUFFIX

Method Summary

Modifier and Type	Method and Description
String	getName()
Object	getParameter()
String	getPropertyName()
boolean	isValid() Return whether the constraint is valid for the owning class
void	setMessageSource(MessageSource source) The message source to evaluate the default messages from
void	setOwningClass(Class<?> owningClass) The class the constraint applies to
void	setParameter(Object parameter) The parameter which the constraint is validated against.
void	setPropertyName(String propertyName) The name of the property the constraint applies to
boolean	supports(Class<?> type) Returns whether the constraint supports being applied against the specified type;
void	validate(Object target, Object propertyValue, Errors errors) Validate this constraint against a property value.

Field Detail

INVALID_SUFFIX

static final String INVALID_SUFFIX

See Also:

Constant Field Values

EXCEEDED_SUFFIX

static final String EXCEEDED_SUFFIX

See Also:

Constant Field Values

NOTMET_SUFFIX

static final String NOTMET_SUFFIX

See Also:

Constant Field Values

NOT_PREFIX

static final String NOT_PREFIX

See Also:

Constant Field Values

TOOBIG_SUFFIX

static final String TOOBIG_SUFFIX

See Also:

Constant Field Values

TOOLONG_SUFFIX

static final String TOOLONG_SUFFIX

See Also:

Constant Field Values

TOOSMALL_SUFFIX

static final String TOOSMALL_SUFFIX

See Also:

Constant Field Values

TOOSHORT_SUFFIX

static final String TOOSHORT_SUFFIX

See Also:

Constant Field Values

Method Detail

supports

boolean supports(@Nonnull
                 Class<?> type)

Returns whether the constraint supports being applied against the specified type;

Parameters:

type - The type to support

Returns:

True if the constraint can be applied against the specified type

isValid

boolean isValid()

Return whether the constraint is valid for the owning class

Returns:

True if it is

validate

void validate(@Nonnull
              Object target,
              @Nullable
              Object propertyValue,
              @Nonnull
              Errors errors)

Validate this constraint against a property value. If implementation is vetoing (isVetoing() method returns true), then it could return 'true' to stop further validation.

Parameters:

target -

propertyValue - The property value to validate

errors - The errors instance to record errors against

setParameter

void setParameter(@Nonnull
                  Object parameter)

The parameter which the constraint is validated against.

Parameters:

parameter -

getParameter

@Nonnull
Object getParameter()

setOwningClass

void setOwningClass(@Nonnull
                    Class<?> owningClass)

The class the constraint applies to

Parameters:

owningClass -

setPropertyName

void setPropertyName(@Nonnull
                     String propertyName)

The name of the property the constraint applies to

Parameters:

propertyName -

getName

@Nonnull
String getName()

Returns:

The name of the constraint

getPropertyName

@Nonnull
String getPropertyName()

Returns:

The property name of the constraint

setMessageSource

void setMessageSource(@Nonnull
                      MessageSource source)

The message source to evaluate the default messages from

Parameters:

source -