ConstrainedProperty (Grails Data Mapping API

grails.gorm.validation.Constrained

All Superinterfaces:

Constrained
```
@groovy.transform.CompileStatic
interface ConstrainedProperty
extends Constrained
```
An interface for a constrained property
Authors:
Graeme Rocher
Since:
6.0

Nested Class Summary

Nested classes
Modifiers	Name	Description
`class`	`ConstrainedProperty.1`

Field Summary

Fields
Modifiers	Name	Description
`static java.lang.String`	`BLANK_CONSTRAINT`
`static java.lang.String`	`CREDIT_CARD_CONSTRAINT`
`static java.lang.String`	`DEFAULT_BLANK_MESSAGE`
`static java.lang.String`	`DEFAULT_BLANK_MESSAGE_CODE`
`static java.lang.String`	`DEFAULT_DOESNT_MATCH_MESSAGE`
`static java.lang.String`	`DEFAULT_DOESNT_MATCH_MESSAGE_CODE`
`static java.lang.String`	`DEFAULT_INVALID_CREDIT_CARD_MESSAGE`
`static java.lang.String`	`DEFAULT_INVALID_CREDIT_CARD_MESSAGE_CODE`
`static java.lang.String`	`DEFAULT_INVALID_EMAIL_MESSAGE`
`static java.lang.String`	`DEFAULT_INVALID_EMAIL_MESSAGE_CODE`
`static java.lang.String`	`DEFAULT_INVALID_MAX_MESSAGE`
`static java.lang.String`	`DEFAULT_INVALID_MAX_MESSAGE_CODE`
`static java.lang.String`	`DEFAULT_INVALID_MAX_SIZE_MESSAGE`
`static java.lang.String`	`DEFAULT_INVALID_MAX_SIZE_MESSAGE_CODE`
`static java.lang.String`	`DEFAULT_INVALID_MIN_MESSAGE`
`static java.lang.String`	`DEFAULT_INVALID_MIN_MESSAGE_CODE`
`static java.lang.String`	`DEFAULT_INVALID_MIN_SIZE_MESSAGE`
`static java.lang.String`	`DEFAULT_INVALID_MIN_SIZE_MESSAGE_CODE`
`static java.lang.String`	`DEFAULT_INVALID_RANGE_MESSAGE`
`static java.lang.String`	`DEFAULT_INVALID_RANGE_MESSAGE_CODE`
`static java.lang.String`	`DEFAULT_INVALID_SIZE_MESSAGE`
`static java.lang.String`	`DEFAULT_INVALID_SIZE_MESSAGE_CODE`
`static java.lang.String`	`DEFAULT_INVALID_URL_MESSAGE`
`static java.lang.String`	`DEFAULT_INVALID_URL_MESSAGE_CODE`
`static java.lang.String`	`DEFAULT_INVALID_VALIDATOR_MESSAGE`
`static java.lang.String`	`DEFAULT_INVALID_VALIDATOR_MESSAGE_CODE`
`static java.util.Map<java.lang.String, java.lang.String>`	`DEFAULT_MESSAGES`
`static java.lang.String`	`DEFAULT_NOT_EQUAL_MESSAGE`
`static java.lang.String`	`DEFAULT_NOT_EQUAL_MESSAGE_CODE`
`static java.lang.String`	`DEFAULT_NOT_INLIST_MESSAGE_CODE`
`static java.lang.String`	`DEFAULT_NOT_IN_LIST_MESSAGE`
`static java.lang.String`	`DEFAULT_NULL_MESSAGE`
`static java.lang.String`	`DEFAULT_NULL_MESSAGE_CODE`
`static java.lang.String`	`EMAIL_CONSTRAINT`
`static java.lang.String`	`EXCEEDED_SUFFIX`
`static java.lang.String`	`INVALID_SUFFIX`
`static java.lang.String`	`IN_LIST_CONSTRAINT`
`static java.lang.String`	`MATCHES_CONSTRAINT`
`static java.lang.String`	`MAX_CONSTRAINT`
`static java.lang.String`	`MAX_SIZE_CONSTRAINT`
`static java.util.ResourceBundle`	`MESSAGE_BUNDLE`
`static java.lang.String`	`MIN_CONSTRAINT`
`static java.lang.String`	`MIN_SIZE_CONSTRAINT`
`static java.lang.String`	`NOTMET_SUFFIX`
`static java.lang.String`	`NOT_EQUAL_CONSTRAINT`
`static java.lang.String`	`NOT_PREFIX`
`static java.lang.String`	`NULLABLE_CONSTRAINT`
`static java.lang.String`	`RANGE_CONSTRAINT`
`static java.lang.String`	`SCALE_CONSTRAINT`
`static java.lang.String`	`SIZE_CONSTRAINT`
`static java.lang.String`	`TOOBIG_SUFFIX`
`static java.lang.String`	`TOOLONG_SUFFIX`
`static java.lang.String`	`TOOSHORT_SUFFIX`
`static java.lang.String`	`TOOSMALL_SUFFIX`
`static java.lang.String`	`URL_CONSTRAINT`
`static java.lang.String`	`VALIDATOR_CONSTRAINT`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`abstract void`	`applyConstraint(java.lang.String constraintName, java.lang.Object constrainingValue)` Apply a named constraint
	`abstract Constraint`	`getAppliedConstraint(java.lang.String name)` Obtain an applied constraint
	`abstract java.util.Collection<Constraint>`	`getAppliedConstraints()` Returns: Returns the appliedConstraints.
	`abstract java.lang.Class`	`getOwner()` Returns: The owner
	`abstract java.lang.String`	`getPropertyName()` Returns: The name of the property constrained
	`abstract java.lang.Class<?>`	`getPropertyType()` Returns: Returns the propertyType.
	`abstract boolean`	`hasAppliedConstraint(java.lang.String constraintName)` Parameters: `constraintName` - The name of the constraint to check
	`abstract boolean`	`supportsContraint(java.lang.String constraintName)` Check whether a given constraint type is supported
	`abstract void`	`validate(java.lang.Object target, java.lang.Object propertyValue, org.springframework.validation.Errors errors)` Validate this constrainted property against specified property value

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`interface Constrained`	`applyConstraint, getFormat, getInList, getMatches, getMax, getMaxSize, getMin, getMinSize, getNotEqual, getOrder, getOwner, getRange, getScale, getSize, getWidget, hasAppliedConstraint, isBlank, isCreditCard, isDisplay, isEditable, isEmail, isNullable, isPassword, isUrl`

- Field Detail
  - public static final java.lang.String BLANK_CONSTRAINT
  - public static final java.lang.String CREDIT_CARD_CONSTRAINT
  - public static final java.lang.String DEFAULT_BLANK_MESSAGE
  - public static final java.lang.String DEFAULT_BLANK_MESSAGE_CODE
  - public static final java.lang.String DEFAULT_DOESNT_MATCH_MESSAGE
  - public static final java.lang.String DEFAULT_DOESNT_MATCH_MESSAGE_CODE
  - public static final java.lang.String DEFAULT_INVALID_CREDIT_CARD_MESSAGE
  - public static final java.lang.String DEFAULT_INVALID_CREDIT_CARD_MESSAGE_CODE
  - public static final java.lang.String DEFAULT_INVALID_EMAIL_MESSAGE
  - public static final java.lang.String DEFAULT_INVALID_EMAIL_MESSAGE_CODE
  - public static final java.lang.String DEFAULT_INVALID_MAX_MESSAGE
  - public static final java.lang.String DEFAULT_INVALID_MAX_MESSAGE_CODE
  - public static final java.lang.String DEFAULT_INVALID_MAX_SIZE_MESSAGE
  - public static final java.lang.String DEFAULT_INVALID_MAX_SIZE_MESSAGE_CODE
  - public static final java.lang.String DEFAULT_INVALID_MIN_MESSAGE
  - public static final java.lang.String DEFAULT_INVALID_MIN_MESSAGE_CODE
  - public static final java.lang.String DEFAULT_INVALID_MIN_SIZE_MESSAGE
  - public static final java.lang.String DEFAULT_INVALID_MIN_SIZE_MESSAGE_CODE
  - public static final java.lang.String DEFAULT_INVALID_RANGE_MESSAGE
  - public static final java.lang.String DEFAULT_INVALID_RANGE_MESSAGE_CODE
  - public static final java.lang.String DEFAULT_INVALID_SIZE_MESSAGE
  - public static final java.lang.String DEFAULT_INVALID_SIZE_MESSAGE_CODE
  - public static final java.lang.String DEFAULT_INVALID_URL_MESSAGE
  - public static final java.lang.String DEFAULT_INVALID_URL_MESSAGE_CODE
  - public static final java.lang.String DEFAULT_INVALID_VALIDATOR_MESSAGE
  - public static final java.lang.String DEFAULT_INVALID_VALIDATOR_MESSAGE_CODE
  - public static final java.util.Map<java.lang.String, java.lang.String> DEFAULT_MESSAGES
  - public static final java.lang.String DEFAULT_NOT_EQUAL_MESSAGE
  - public static final java.lang.String DEFAULT_NOT_EQUAL_MESSAGE_CODE
  - public static final java.lang.String DEFAULT_NOT_INLIST_MESSAGE_CODE
  - public static final java.lang.String DEFAULT_NOT_IN_LIST_MESSAGE
  - public static final java.lang.String DEFAULT_NULL_MESSAGE
  - public static final java.lang.String DEFAULT_NULL_MESSAGE_CODE
  - public static final java.lang.String EMAIL_CONSTRAINT
  - public static final java.lang.String EXCEEDED_SUFFIX
  - public static final java.lang.String INVALID_SUFFIX
  - public static final java.lang.String IN_LIST_CONSTRAINT
  - public static final java.lang.String MATCHES_CONSTRAINT
  - public static final java.lang.String MAX_CONSTRAINT
  - public static final java.lang.String MAX_SIZE_CONSTRAINT
  - public static final java.util.ResourceBundle MESSAGE_BUNDLE
  - public static final java.lang.String MIN_CONSTRAINT
  - public static final java.lang.String MIN_SIZE_CONSTRAINT
  - public static final java.lang.String NOTMET_SUFFIX
  - public static final java.lang.String NOT_EQUAL_CONSTRAINT
  - public static final java.lang.String NOT_PREFIX
  - public static final java.lang.String NULLABLE_CONSTRAINT
  - public static final java.lang.String RANGE_CONSTRAINT
  - public static final java.lang.String SCALE_CONSTRAINT
  - public static final java.lang.String SIZE_CONSTRAINT
  - public static final java.lang.String TOOBIG_SUFFIX
  - public static final java.lang.String TOOLONG_SUFFIX
  - public static final java.lang.String TOOSHORT_SUFFIX
  - public static final java.lang.String TOOSMALL_SUFFIX
  - public static final java.lang.String URL_CONSTRAINT
  - public static final java.lang.String VALIDATOR_CONSTRAINT
- Method Detail
  - abstract void applyConstraint(java.lang.String constraintName, java.lang.Object constrainingValue)
    
    Apply a named constraint
    Parameters:
    constraintName - The name of the constraint
    constrainingValue - The value to constrain by
  - abstract Constraint getAppliedConstraint(java.lang.String name)
    
    Obtain an applied constraint
    Parameters:
    name - The name
    Returns:
    The constraint or null if it doesn't exist
  - abstract java.util.Collection<Constraint> getAppliedConstraints()
    
    Returns:
    Returns the appliedConstraints.
  - abstract java.lang.Class getOwner()
    
    Returns:
    The owner
  - abstract java.lang.String getPropertyName()
    
    Returns:
    The name of the property constrained
  - abstract java.lang.Class<?> getPropertyType()
    
    Returns:
    Returns the propertyType.
  - abstract boolean hasAppliedConstraint(java.lang.String constraintName)
    
    Parameters:
    constraintName - The name of the constraint to check
    Returns:
    Returns true if the specified constraint name is being applied to this property
  - abstract boolean supportsContraint(java.lang.String constraintName)
    
    Check whether a given constraint type is supported
    Parameters:
    constraintName - The name of the constraint
    Returns:
    True if it is supported
  - abstract void validate(java.lang.Object target, java.lang.Object propertyValue, org.springframework.validation.Errors errors)
    
    Validate this constrainted property against specified property value
    Parameters:
    target - The target object to validate
    propertyValue - The value of the property to validate
    errors - The Errors instances to report errors to

Summary:
Nested
Field
Method

| Detail:
Field
Method

Groovy Documentation

[Groovy] Interface ConstrainedProperty

Nested Class Summary

Field Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final java.lang.String BLANK_CONSTRAINT

public static final java.lang.String CREDIT_CARD_CONSTRAINT

public static final java.lang.String DEFAULT_BLANK_MESSAGE

public static final java.lang.String DEFAULT_BLANK_MESSAGE_CODE

public static final java.lang.String DEFAULT_DOESNT_MATCH_MESSAGE

public static final java.lang.String DEFAULT_DOESNT_MATCH_MESSAGE_CODE

public static final java.lang.String DEFAULT_INVALID_CREDIT_CARD_MESSAGE

public static final java.lang.String DEFAULT_INVALID_CREDIT_CARD_MESSAGE_CODE

public static final java.lang.String DEFAULT_INVALID_EMAIL_MESSAGE

public static final java.lang.String DEFAULT_INVALID_EMAIL_MESSAGE_CODE

public static final java.lang.String DEFAULT_INVALID_MAX_MESSAGE

public static final java.lang.String DEFAULT_INVALID_MAX_MESSAGE_CODE

public static final java.lang.String DEFAULT_INVALID_MAX_SIZE_MESSAGE

public static final java.lang.String DEFAULT_INVALID_MAX_SIZE_MESSAGE_CODE

public static final java.lang.String DEFAULT_INVALID_MIN_MESSAGE

public static final java.lang.String DEFAULT_INVALID_MIN_MESSAGE_CODE

public static final java.lang.String DEFAULT_INVALID_MIN_SIZE_MESSAGE

public static final java.lang.String DEFAULT_INVALID_MIN_SIZE_MESSAGE_CODE

public static final java.lang.String DEFAULT_INVALID_RANGE_MESSAGE

public static final java.lang.String DEFAULT_INVALID_RANGE_MESSAGE_CODE

public static final java.lang.String DEFAULT_INVALID_SIZE_MESSAGE

public static final java.lang.String DEFAULT_INVALID_SIZE_MESSAGE_CODE

public static final java.lang.String DEFAULT_INVALID_URL_MESSAGE

public static final java.lang.String DEFAULT_INVALID_URL_MESSAGE_CODE

public static final java.lang.String DEFAULT_INVALID_VALIDATOR_MESSAGE

public static final java.lang.String DEFAULT_INVALID_VALIDATOR_MESSAGE_CODE

public static final java.util.Map<java.lang.String, java.lang.String> DEFAULT_MESSAGES

public static final java.lang.String DEFAULT_NOT_EQUAL_MESSAGE

public static final java.lang.String DEFAULT_NOT_EQUAL_MESSAGE_CODE

public static final java.lang.String DEFAULT_NOT_INLIST_MESSAGE_CODE

public static final java.lang.String DEFAULT_NOT_IN_LIST_MESSAGE

public static final java.lang.String DEFAULT_NULL_MESSAGE

public static final java.lang.String DEFAULT_NULL_MESSAGE_CODE

public static final java.lang.String EMAIL_CONSTRAINT

public static final java.lang.String EXCEEDED_SUFFIX

public static final java.lang.String INVALID_SUFFIX

public static final java.lang.String IN_LIST_CONSTRAINT

public static final java.lang.String MATCHES_CONSTRAINT

public static final java.lang.String MAX_CONSTRAINT

public static final java.lang.String MAX_SIZE_CONSTRAINT

public static final java.util.ResourceBundle MESSAGE_BUNDLE

public static final java.lang.String MIN_CONSTRAINT

public static final java.lang.String MIN_SIZE_CONSTRAINT

public static final java.lang.String NOTMET_SUFFIX

public static final java.lang.String NOT_EQUAL_CONSTRAINT

public static final java.lang.String NOT_PREFIX

public static final java.lang.String NULLABLE_CONSTRAINT

public static final java.lang.String RANGE_CONSTRAINT

public static final java.lang.String SCALE_CONSTRAINT

public static final java.lang.String SIZE_CONSTRAINT

public static final java.lang.String TOOBIG_SUFFIX

public static final java.lang.String TOOLONG_SUFFIX

public static final java.lang.String TOOSHORT_SUFFIX

public static final java.lang.String TOOSMALL_SUFFIX

public static final java.lang.String URL_CONSTRAINT

public static final java.lang.String VALIDATOR_CONSTRAINT

Method Detail

abstract void applyConstraint(java.lang.String constraintName, java.lang.Object constrainingValue)

abstract Constraint getAppliedConstraint(java.lang.String name)

abstract java.util.Collection<Constraint> getAppliedConstraints()

abstract java.lang.Class getOwner()

abstract java.lang.String getPropertyName()

abstract java.lang.Class<?> getPropertyType()

abstract boolean hasAppliedConstraint(java.lang.String constraintName)

abstract boolean supportsContraint(java.lang.String constraintName)

abstract void validate(java.lang.Object target, java.lang.Object propertyValue, org.springframework.validation.Errors errors)