org.codehaus.griffon.runtime.validation.constraints

Class AbstractConstraint

java.lang.Object

org.codehaus.griffon.runtime.validation.constraints.AbstractConstraint

All Implemented Interfaces:

Constraint

Direct Known Subclasses:

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

public abstract class AbstractConstraint
extends Object
implements Constraint

Abstract class for constraints to extend.

Author:

Graeme Rocher (Grails)

Field Summary

Fields

Modifier and Type	Field and Description
protected String	classShortName
protected Class<?>	constraintOwningClass
protected Object	constraintParameter
protected String	constraintPropertyName
protected MessageSource	messageSource

Fields inherited from interface griffon.plugins.validation.constraints.Constraint

EXCEEDED_SUFFIX, INVALID_SUFFIX, NOT_PREFIX, NOTMET_SUFFIX, TOOBIG_SUFFIX, TOOLONG_SUFFIX, TOOSHORT_SUFFIX, TOOSMALL_SUFFIX

Constructor Summary

Constructors

Constructor and Description
AbstractConstraint()

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface griffon.plugins.validation.constraints.Constraint

getName, supports

Field Detail

constraintPropertyName

protected String constraintPropertyName

constraintOwningClass

protected Class<?> constraintOwningClass

constraintParameter

protected Object constraintParameter

classShortName

protected String classShortName

messageSource

protected MessageSource messageSource

Constructor Detail

AbstractConstraint

public AbstractConstraint()

Method Detail

setMessageSource

public void setMessageSource(@Nonnull
                             MessageSource source)

Description copied from interface: Constraint

The message source to evaluate the default messages from

Specified by:

setMessageSource in interface Constraint

getPropertyName

@Nonnull
public String getPropertyName()

Specified by:

getPropertyName in interface Constraint

Returns:

The property name of the constraint

setOwningClass

public void setOwningClass(@Nonnull
                           Class constraintOwningClass)

Description copied from interface: Constraint

The class the constraint applies to

Specified by:

setOwningClass in interface Constraint

setPropertyName

public void setPropertyName(@Nonnull
                            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(@Nonnull
                         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

@Nonnull
public Object getParameter()

Specified by:

getParameter in interface Constraint

checkState

protected void checkState()

validate

public void validate(@Nonnull
                     Object target,
                     @Nullable
                     Object propertyValue,
                     @Nonnull
                     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

skipNullValues

protected boolean skipNullValues()

skipBlankValues

protected boolean skipBlankValues()

rejectValue

public void rejectValue(@Nonnull
                        Object target,
                        @Nonnull
                        Errors errors,
                        String defaultMessageCode,
                        Object[] args)

rejectValue

public void rejectValue(@Nonnull
                        Object target,
                        @Nonnull
                        Errors errors,
                        String defaultMessageCode,
                        String code,
                        Object[] args)

rejectValue

public void rejectValue(@Nonnull
                        Object target,
                        @Nonnull
                        Errors errors,
                        String defaultMessageCode,
                        String[] codes,
                        Object[] args)

rejectValueWithDefaultMessage

public void rejectValueWithDefaultMessage(@Nonnull
                                          Object target,
                                          @Nonnull
                                          Errors errors,
                                          String defaultMessage,
                                          String[] codes,
                                          Object[] args)

rejectValue

public void rejectValue(@Nonnull
                        Object target,
                        @Nonnull
                        Errors errors,
                        String code,
                        String defaultMessage)

rejectValue

public void rejectValue(@Nonnull
                        Object target,
                        @Nonnull
                        Errors errors,
                        String code,
                        Object[] args,
                        String defaultMessage)

getDefaultMessage

protected String getDefaultMessage(String code)

Returns the default message for the given message code in the current locale. Note that the string returned includes any placeholders that the required message has - these must be expanded by the caller if required.

Parameters:

code - The i18n message code to look up.

Returns:

The message corresponding to the given code in the current locale.

processValidate

protected abstract void processValidate(@Nonnull
                                        Object target,
                                        Object propertyValue,
                                        @Nonnull
                                        Errors errors)

toString

public String toString()

Overrides:

toString in class 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