org.codehaus.groovy.grails.validation

Class AbstractConstraint

java.lang.Object

org.codehaus.groovy.grails.validation.AbstractConstraint

All Implemented Interfaces:

Constraint

Direct Known Subclasses:

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

public abstract class AbstractConstraint
extends java.lang.Object
implements Constraint

Abstract class for constraints to extend.

Author:

Graeme Rocher

Constructor Summary

Constructors

Constructor and Description
AbstractConstraint()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getParameter()
java.lang.String	getPropertyName()
boolean	isValid() Return whether the constraint is valid for the owning class
void	rejectValue(java.lang.Object target, Errors errors, java.lang.String defaultMessageCode, java.lang.Object[] args)
void	rejectValue(java.lang.Object target, Errors errors, java.lang.String code, java.lang.Object[] args, java.lang.String defaultMessage)
void	rejectValue(java.lang.Object target, Errors errors, java.lang.String code, java.lang.String defaultMessage)
void	rejectValue(java.lang.Object target, Errors errors, java.lang.String defaultMessageCode, java.lang.String[] codes, java.lang.Object[] args)
void	rejectValue(java.lang.Object target, Errors errors, java.lang.String defaultMessageCode, java.lang.String code, java.lang.Object[] args)
void	rejectValueWithDefaultMessage(java.lang.Object target, Errors errors, java.lang.String defaultMessage, java.lang.String[] codes, java.lang.Object[] args)
void	setMessageSource(MessageSource source) The message source to evaluate the default messages from
void	setOwningClass(java.lang.Class constraintOwningClass) The class the constraint applies to
void	setParameter(java.lang.Object constraintParameter) The parameter which the constraint is validated against.
void	setPropertyName(java.lang.String constraintPropertyName) The name of the property the constraint applies to
java.lang.String	toString()
void	validate(java.lang.Object target, java.lang.Object propertyValue, Errors errors) Validate this constraint against a property value.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.codehaus.groovy.grails.validation.Constraint

getName, supports

Constructor Detail

AbstractConstraint

public AbstractConstraint()

Method Detail

setMessageSource

public void setMessageSource(MessageSource source)

Description copied from interface: Constraint

The message source to evaluate the default messages from

Specified by:

setMessageSource in interface Constraint

getPropertyName

public java.lang.String getPropertyName()

Specified by:

getPropertyName in interface Constraint

Returns:

The property name of the constraint

setOwningClass

public void setOwningClass(java.lang.Class constraintOwningClass)

The class the constraint applies to

Specified by:

setOwningClass in interface Constraint

See Also:

Constraint.setOwningClass(java.lang.Class)

setPropertyName

public void setPropertyName(java.lang.String constraintPropertyName)

Description copied from interface: Constraint

The name of the property the constraint applies to

Specified by:

setPropertyName in interface Constraint

Parameters:

constraintPropertyName - The constraintPropertyName to set.

setParameter

public void setParameter(java.lang.Object constraintParameter)

Description copied from interface: Constraint

The parameter which the constraint is validated against.

Specified by:

setParameter in interface Constraint

Parameters:

constraintParameter - The constraintParameter to set.

getParameter

public java.lang.Object getParameter()

Specified by:

getParameter in interface Constraint

validate

public void validate(java.lang.Object target,
                     java.lang.Object propertyValue,
                     Errors errors)

Description copied from interface: Constraint

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

Specified by:

validate in interface Constraint

propertyValue - The property value to validate

errors - The errors instance to record errors against

rejectValue

public void rejectValue(java.lang.Object target,
                        Errors errors,
                        java.lang.String defaultMessageCode,
                        java.lang.Object[] args)

rejectValue

public void rejectValue(java.lang.Object target,
                        Errors errors,
                        java.lang.String defaultMessageCode,
                        java.lang.String code,
                        java.lang.Object[] args)

rejectValue

public void rejectValue(java.lang.Object target,
                        Errors errors,
                        java.lang.String defaultMessageCode,
                        java.lang.String[] codes,
                        java.lang.Object[] args)

rejectValueWithDefaultMessage

public void rejectValueWithDefaultMessage(java.lang.Object target,
                                          Errors errors,
                                          java.lang.String defaultMessage,
                                          java.lang.String[] codes,
                                          java.lang.Object[] args)

rejectValue

public void rejectValue(java.lang.Object target,
                        Errors errors,
                        java.lang.String code,
                        java.lang.String defaultMessage)

rejectValue

public void rejectValue(java.lang.Object target,
                        Errors errors,
                        java.lang.String code,
                        java.lang.Object[] args,
                        java.lang.String defaultMessage)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isValid

public boolean isValid()

Return whether the constraint is valid for the owning class

Specified by:

isValid in interface Constraint

Returns:

True if it is