DefaultConstrainedProperty (GORM for Rx 6.1.9.RELEASE)

grails.gorm.validation.DefaultConstrainedProperty

All Implemented Interfaces and Traits:: ConstrainedProperty

@groovy.transform.CompileStatic
@groovy.util.logging.Slf4j
@groovy.transform.ToString(includes = ['owningClass', 'propertyType', 'propertyName', 'appliedConstraints'])
class DefaultConstrainedProperty
extends java.lang.Object

Default implementation of the ConstrainedProperty interface

Authors:: Graeme Rocher

Since:: 6.0

Field Summary

Fields
Modifiers	Name	Description
`protected java.util.Map<java.lang.String, Constraint>`	`appliedConstraints`
`protected ConstraintRegistry`	`constraintRegistry`

Properties Summary

Properties
Type	Name and description
`java.util.Map`	`attributes`
`boolean`	`display` whether the property should be displayed
`boolean`	`editable` whether the property is editable
`java.lang.String`	`format` the format of the property (for example a date pattern)
`int`	`order` The order of the property
`java.lang.Class<?>`	`owningClass` The owning class
`boolean`	`password` whether the property is a password
`java.lang.String`	`propertyName` the property name
`java.lang.Class<?>`	`propertyType` The property type
`java.lang.String`	`widget` The widget to use to render the property

Constructor Summary

Constructors
Constructor and description
`DefaultConstrainedProperty (java.lang.Class<?> owningClass, java.lang.String propertyName, java.lang.Class<?> propertyType, ConstraintRegistry constraintRegistry)` Constructs a new ConstrainedProperty for the given arguments.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`addMetaConstraint(java.lang.String name, java.lang.Object value)` Adds a meta constraints which is a non-validating informational constraint.
	`void`	`applyConstraint(java.lang.String constraintName, java.lang.Object constrainingValue)` Applies a constraint for the specified name and consraint value.
	`protected void`	`applyConstraintInternal(java.lang.String constraintName, java.lang.Object constrainingValue)`
	`Constraint`	`getAppliedConstraint(java.lang.String name)` Obtains an applied constraint by name.
	`java.util.Collection<Constraint>`	`getAppliedConstraints()` @return Returns the appliedConstraints.
	`java.util.Map`	`getAttributes()`
	`java.util.List`	`getInList()` @return Returns the inList.
	`java.lang.String`	`getMatches()` @return Returns the matches.
	`java.lang.Comparable`	`getMax()` @return Returns the max.
	`java.lang.Integer`	`getMaxSize()` @return Returns the maxSize.
	`java.lang.Object`	`getMetaConstraintValue(java.lang.String name)` Obtains the value of the named meta constraint.
	`java.util.Map<java.lang.String, java.lang.Object>`	`getMetaConstraints()` @return Returns the metaConstraints.
	`java.lang.Comparable`	`getMin()` @return Returns the min.
	`java.lang.Integer`	`getMinSize()` @return Returns the minSize.
	`java.lang.Object`	`getNotEqual()` @return Returns the notEqual.
	`java.lang.Class`	`getOwner()`
	`groovy.lang.Range`	`getRange()` @return Returns the range.
	`java.lang.Integer`	`getScale()` @return The scale, if defined for this property; null, otherwise
	`groovy.lang.Range`	`getSize()` @return Returns the size.
	`boolean`	`hasAppliedConstraint(java.lang.String constraintName)` @param constraintName The name of the constraint to check
	`boolean`	`isBlank()` @return the blank.
	`boolean`	`isCreditCard()` @return Returns the creditCard.
	`boolean`	`isEmail()` @return Returns the email.
	`boolean`	`isNullable()` @return Returns the nullable.
	`boolean`	`isUrl()` @return Returns the url.
	`void`	`setAttributes(java.util.Map attributes)`
	`void`	`setBlank(boolean blank)` @param blank The blank to set.
	`void`	`setCreditCard(boolean creditCard)` @param creditCard The creditCard to set.
	`void`	`setEmail(boolean email)` @param email The email to set.
	`void`	`setInList(java.util.List inList)` @param inList The inList to set.
	`void`	`setMatches(java.lang.String regex)` @param regex The matches to set.
	`void`	`setMax(java.lang.Comparable max)` @param max The max to set.
	`void`	`setMaxSize(java.lang.Integer maxSize)` @param maxSize The maxSize to set.
	`void`	`setMin(java.lang.Comparable min)` @param min The min to set.
	`void`	`setMinSize(java.lang.Integer minSize)` @param minSize The minLength to set.
	`void`	`setNotEqual(java.lang.Object notEqual)` @param notEqual The notEqual to set.
	`void`	`setNullable(boolean nullable)` @param nullable The nullable to set.
	`void`	`setRange(groovy.lang.Range range)` @param range The range to set.
	`void`	`setSize(groovy.lang.Range size)` @param size The size to set.
	`void`	`setUrl(boolean url)` @param url The url to set.
	`boolean`	`supportsContraint(java.lang.String constraintName)` Checks with this ConstraintedProperty instance supports applying the specified constraint.
	`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
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Field Detail
  - protected final java.util.Map<java.lang.String, Constraint> appliedConstraints
  - protected final ConstraintRegistry constraintRegistry
- Property Detail
  - java.util.Map attributes
  - boolean display
    
    whether the property should be displayed
  - boolean editable
    
    whether the property is editable
  - java.lang.String format
    
    the format of the property (for example a date pattern)
  - int order
    
    The order of the property
  - final java.lang.Class<?> owningClass
    
    The owning class
  - boolean password
    
    whether the property is a password
  - final java.lang.String propertyName
    
    the property name
  - final java.lang.Class<?> propertyType
    
    The property type
  - java.lang.String widget
    
    The widget to use to render the property
- Constructor Detail
  - DefaultConstrainedProperty(java.lang.Class<?> owningClass, java.lang.String propertyName, java.lang.Class<?> propertyType, ConstraintRegistry constraintRegistry)
    
    Constructs a new ConstrainedProperty for the given arguments.
    Parameters:
    owningClass - The owning class
    propertyName - The name of the property
    propertyType - The property type
- Method Detail
  - void addMetaConstraint(java.lang.String name, java.lang.Object value)
    
    Adds a meta constraints which is a non-validating informational constraint.
    Parameters:
    name - The name of the constraint
    value - The value
  - @java.lang.Override void applyConstraint(java.lang.String constraintName, java.lang.Object constrainingValue)
    
    Applies a constraint for the specified name and consraint value.
    throws:
    ValidationConfigurationException Thrown when the specified constraint is not supported by this ConstrainedProperty. Use supportsContraint(String constraintName) to check before calling
    
    Parameters:
    constraintName - The name of the constraint
    constrainingValue - The constraining value
  - protected void applyConstraintInternal(java.lang.String constraintName, java.lang.Object constrainingValue)
  - @java.lang.Override Constraint getAppliedConstraint(java.lang.String name)
    
    Obtains an applied constraint by name.
    Returns:
    The applied constraint
    Parameters:
    name - The name of the constraint
  - @java.lang.Override java.util.Collection<Constraint> getAppliedConstraints()
    
    Returns:
    Returns the appliedConstraints.
  - @java.lang.SuppressWarnings("rawtypes") java.util.Map getAttributes()
  - @java.lang.Override @java.lang.SuppressWarnings("rawtypes") java.util.List getInList()
    
    Returns:
    Returns the inList.
  - @java.lang.Override java.lang.String getMatches()
    
    Returns:
    Returns the matches.
  - @java.lang.Override java.lang.Comparable getMax()
    
    Returns:
    Returns the max.
  - @java.lang.Override java.lang.Integer getMaxSize()
    
    Returns:
    Returns the maxSize.
  - java.lang.Object getMetaConstraintValue(java.lang.String name)
    
    Obtains the value of the named meta constraint.
    Returns:
    The value
    Parameters:
    name - The name of the constraint
  - java.util.Map<java.lang.String, java.lang.Object> getMetaConstraints()
    
    Returns:
    Returns the metaConstraints.
  - @java.lang.Override java.lang.Comparable getMin()
    
    Returns:
    Returns the min.
  - @java.lang.Override java.lang.Integer getMinSize()
    
    Returns:
    Returns the minSize.
  - @java.lang.Override java.lang.Object getNotEqual()
    
    Returns:
    Returns the notEqual.
  - @java.lang.Override java.lang.Class getOwner()
  - @java.lang.Override @java.lang.SuppressWarnings("rawtypes") groovy.lang.Range getRange()
    
    Returns:
    Returns the range.
  - @java.lang.Override java.lang.Integer getScale()
    
    Returns:
    The scale, if defined for this property; null, otherwise
  - @java.lang.Override @java.lang.SuppressWarnings("rawtypes") groovy.lang.Range getSize()
    
    Returns:
    Returns the size.
  - @java.lang.Override boolean hasAppliedConstraint(java.lang.String constraintName)
    
    Returns:
    Returns true if the specified constraint name is being applied to this property
    Parameters:
    constraintName - The name of the constraint to check
  - @java.lang.Override boolean isBlank()
    
    Returns:
    the blank.
  - @java.lang.Override boolean isCreditCard()
    
    Returns:
    Returns the creditCard.
  - @java.lang.Override boolean isEmail()
    
    Returns:
    Returns the email.
  - @java.lang.Override boolean isNullable()
    
    Returns:
    Returns the nullable.
  - @java.lang.Override boolean isUrl()
    
    Returns:
    Returns the url.
  - @java.lang.SuppressWarnings("rawtypes") void setAttributes(java.util.Map attributes)
  - void setBlank(boolean blank)
    
    Parameters:
    blank - The blank to set.
  - void setCreditCard(boolean creditCard)
    
    Parameters:
    creditCard - The creditCard to set.
  - void setEmail(boolean email)
    
    Parameters:
    email - The email to set.
  - @java.lang.SuppressWarnings("rawtypes") void setInList(java.util.List inList)
    
    Parameters:
    inList - The inList to set.
  - void setMatches(java.lang.String regex)
    
    Parameters:
    regex - The matches to set.
  - @java.lang.SuppressWarnings("rawtypes") void setMax(java.lang.Comparable max)
    
    Parameters:
    max - The max to set.
  - void setMaxSize(java.lang.Integer maxSize)
    
    Parameters:
    maxSize - The maxSize to set.
  - @java.lang.SuppressWarnings("rawtypes") void setMin(java.lang.Comparable min)
    
    Parameters:
    min - The min to set.
  - void setMinSize(java.lang.Integer minSize)
    
    Parameters:
    minSize - The minLength to set.
  - void setNotEqual(java.lang.Object notEqual)
    
    Parameters:
    notEqual - The notEqual to set.
  - void setNullable(boolean nullable)
    
    Parameters:
    nullable - The nullable to set.
  - @java.lang.SuppressWarnings("rawtypes") void setRange(groovy.lang.Range range)
    
    Parameters:
    range - The range to set.
  - @java.lang.SuppressWarnings("rawtypes") void setSize(groovy.lang.Range size)
    
    Parameters:
    size - The size to set.
  - void setUrl(boolean url)
    
    Parameters:
    url - The url to set.
  - @java.lang.Override boolean supportsContraint(java.lang.String constraintName)
    
    Checks with this ConstraintedProperty instance supports applying the specified constraint.
    Returns:
    true if the constraint is supported
    Parameters:
    constraintName - The name of the constraint
  - 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:
Field
Property
Constructor
Method

[Groovy] Class DefaultConstrainedProperty

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected final java.util.Map<java.lang.String, Constraint> appliedConstraints

protected final ConstraintRegistry constraintRegistry

Property Detail

java.util.Map attributes

boolean display

boolean editable

java.lang.String format

int order

final java.lang.Class<?> owningClass

boolean password

final java.lang.String propertyName

final java.lang.Class<?> propertyType

java.lang.String widget

Constructor Detail

DefaultConstrainedProperty(java.lang.Class<?> owningClass, java.lang.String propertyName, java.lang.Class<?> propertyType, ConstraintRegistry constraintRegistry)

Method Detail

void addMetaConstraint(java.lang.String name, java.lang.Object value)

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

protected void applyConstraintInternal(java.lang.String constraintName, java.lang.Object constrainingValue)

@java.lang.Override Constraint getAppliedConstraint(java.lang.String name)

@java.lang.Override java.util.Collection<Constraint> getAppliedConstraints()

@java.lang.SuppressWarnings("rawtypes") java.util.Map getAttributes()

@java.lang.Override @java.lang.SuppressWarnings("rawtypes") java.util.List getInList()

@java.lang.Override java.lang.String getMatches()

@java.lang.Override java.lang.Comparable getMax()

@java.lang.Override java.lang.Integer getMaxSize()

java.lang.Object getMetaConstraintValue(java.lang.String name)

java.util.Map<java.lang.String, java.lang.Object> getMetaConstraints()

@java.lang.Override java.lang.Comparable getMin()

@java.lang.Override java.lang.Integer getMinSize()

@java.lang.Override java.lang.Object getNotEqual()

@java.lang.Override java.lang.Class getOwner()

@java.lang.Override @java.lang.SuppressWarnings("rawtypes") groovy.lang.Range getRange()

@java.lang.Override java.lang.Integer getScale()

@java.lang.Override @java.lang.SuppressWarnings("rawtypes") groovy.lang.Range getSize()

@java.lang.Override boolean hasAppliedConstraint(java.lang.String constraintName)

@java.lang.Override boolean isBlank()

@java.lang.Override boolean isCreditCard()

@java.lang.Override boolean isEmail()

@java.lang.Override boolean isNullable()

@java.lang.Override boolean isUrl()

@java.lang.SuppressWarnings("rawtypes") void setAttributes(java.util.Map attributes)

void setBlank(boolean blank)

void setCreditCard(boolean creditCard)

void setEmail(boolean email)

@java.lang.SuppressWarnings("rawtypes") void setInList(java.util.List inList)

void setMatches(java.lang.String regex)

@java.lang.SuppressWarnings("rawtypes") void setMax(java.lang.Comparable max)

void setMaxSize(java.lang.Integer maxSize)

@java.lang.SuppressWarnings("rawtypes") void setMin(java.lang.Comparable min)

void setMinSize(java.lang.Integer minSize)

void setNotEqual(java.lang.Object notEqual)

void setNullable(boolean nullable)

@java.lang.SuppressWarnings("rawtypes") void setRange(groovy.lang.Range range)

@java.lang.SuppressWarnings("rawtypes") void setSize(groovy.lang.Range size)

void setUrl(boolean url)

@java.lang.Override boolean supportsContraint(java.lang.String constraintName)

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