DefaultConstrainedProperty (GORM for Rx 8.1.2)

grails.gorm.validation.DefaultConstrainedProperty

All Implemented Interfaces and Traits:: grails.gorm.validation.ConstrainedProperty

@groovy.transform.CompileStatic
@groovy.util.logging.Slf4j
@groovy.transform.ToString(includes: [owningClass, propertyType, propertyName, appliedConstraints])
class DefaultConstrainedProperty
extends java.lang.Object
implements grails.gorm.validation.ConstrainedProperty

Default implementation of the grails.gorm.validation.ConstrainedProperty interface

Authors:: Graeme Rocher

Since:: 6.0

Field Summary

Fields
Modifiers	Name	Description
`private static ClassPropertyFetcher`	`PROPERTY_FETCHER`
`protected java.util.Map<java.lang.String, Constraint>`	`appliedConstraints`
`private java.util.Map`	`attributes`
`protected ConstraintRegistry`	`constraintRegistry`
`private boolean`	`display`	whether the property should be displayed
`private boolean`	`editable`	whether the property is editable
`private java.lang.String`	`format`	the format of the property (for example a date pattern)
`private java.util.Map<java.lang.String, java.lang.Object>`	`metaConstraints`
`private int`	`order`	The order of the property
`private java.lang.Class<?>`	`owningClass`	The owning class
`private boolean`	`password`	whether the property is a password
`private java.lang.String`	`propertyName`	the property name
`private java.lang.Class<?>`	`propertyType`	The property type
`private java.lang.String`	`widget`	The widget to use to render the property

Properties Summary

Properties
Type	Name and description
`java.util.Map`	`attributes`
`java.util.Map`	`attributes`
`boolean`	`blank`
`boolean`	`creditCard`
`boolean`	`display` whether the property should be displayed
`boolean`	`editable` whether the property is editable
`boolean`	`email`
`java.lang.String`	`format` the format of the property (for example a date pattern)
`java.util.List`	`inList`
`java.lang.String`	`matches`
`java.lang.Comparable`	`max`
`java.lang.Integer`	`maxSize`
`java.lang.Comparable`	`min`
`java.lang.Integer`	`minSize`
`java.lang.Object`	`notEqual`
`boolean`	`nullable`
`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
`groovy.lang.Range`	`range`
`groovy.lang.Range`	`size`
`boolean`	`url`
`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()` Returns: Returns the appliedConstraints.
	`java.util.Map`	`getAttributes()`
	`java.util.List`	`getInList()` Returns: Returns the inList.
	`java.lang.String`	`getMatches()` Returns: Returns the matches.
	`java.lang.Comparable`	`getMax()` Returns: Returns the max.
	`java.lang.Integer`	`getMaxSize()` Returns: 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()` Returns: Returns the metaConstraints.
	`java.lang.Comparable`	`getMin()` Returns: Returns the min.
	`java.lang.Integer`	`getMinSize()` Returns: Returns the minSize.
	`java.lang.Object`	`getNotEqual()` Returns: Returns the notEqual.
	`java.lang.Class`	`getOwner()`
	`groovy.lang.Range`	`getRange()` Returns: Returns the range.
	`java.lang.Integer`	`getScale()` Returns: The scale, if defined for this property; null, otherwise
	`groovy.lang.Range`	`getSize()` Returns: Returns the size.
	`boolean`	`hasAppliedConstraint(java.lang.String constraintName)` Parameters: `constraintName` - The name of the constraint to check
	`private Constraint`	`instantiateConstraint(java.lang.String constraintName, java.lang.Object constraintValue, boolean validate)`
	`boolean`	`isBlank()` Returns: the blank.
	`boolean`	`isCreditCard()` Returns: Returns the creditCard.
	`boolean`	`isEmail()` Returns: Returns the email.
	`private boolean`	`isNotValidStringType()`
	`boolean`	`isNullable()` Returns: Returns the nullable.
	`boolean`	`isUrl()` Returns: Returns the url.
	`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.
	`void`	`setInList(java.util.List inList)` Parameters: `inList` - The inList to set.
	`void`	`setMatches(java.lang.String regex)` Parameters: `regex` - The matches to set.
	`void`	`setMax(java.lang.Comparable max)` Parameters: `max` - The max to set.
	`void`	`setMaxSize(java.lang.Integer maxSize)` Parameters: `maxSize` - The maxSize to set.
	`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.
	`void`	`setRange(groovy.lang.Range range)` Parameters: `range` - The range to set.
	`void`	`setSize(groovy.lang.Range size)` Parameters: `size` - The size to set.
	`void`	`setUrl(boolean url)` Parameters: `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), java.lang.Object#wait(long, int), 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
  - private static final ClassPropertyFetcher PROPERTY_FETCHER
  - protected final java.util.Map<java.lang.String, Constraint> appliedConstraints
  - private java.util.Map attributes
  - protected final ConstraintRegistry constraintRegistry
  - private boolean display
    
    whether the property should be displayed
  - private boolean editable
    
    whether the property is editable
  - private java.lang.String format
    
    the format of the property (for example a date pattern)
  - private java.util.Map<java.lang.String, java.lang.Object> metaConstraints
  - private int order
    
    The order of the property
  - private final java.lang.Class<?> owningClass
    
    The owning class
  - private boolean password
    
    whether the property is a password
  - private final java.lang.String propertyName
    
    the property name
  - private final java.lang.Class<?> propertyType
    
    The property type
  - private java.lang.String widget
    
    The widget to use to render the property
- Property Detail
  - java.util.Map attributes
  - java.util.Map attributes
  - boolean blank
  - boolean creditCard
  - boolean display
    
    whether the property should be displayed
  - boolean editable
    
    whether the property is editable
  - boolean email
  - java.lang.String format
    
    the format of the property (for example a date pattern)
  - java.util.List inList
  - java.lang.String matches
  - java.lang.Comparable max
  - java.lang.Integer maxSize
  - java.lang.Comparable min
  - java.lang.Integer minSize
  - java.lang.Object notEqual
  - boolean nullable
  - 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
  - groovy.lang.Range range
  - groovy.lang.Range size
  - boolean url
  - 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.
    Parameters:
    name - The name of the constraint
    Returns:
    The applied constraint
  - @java.lang.Override java.util.Collection<Constraint> getAppliedConstraints()
    
    Returns:
    Returns the appliedConstraints.
  - @java.lang.SuppressWarnings(value: rawtypes) java.util.Map getAttributes()
  - @java.lang.Override @java.lang.SuppressWarnings(value: 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.
    Parameters:
    name - The name of the constraint
    Returns:
    The value
  - 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(value: 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(value: rawtypes) groovy.lang.Range getSize()
    
    Returns:
    Returns the size.
  - @java.lang.Override 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
  - private Constraint instantiateConstraint(java.lang.String constraintName, java.lang.Object constraintValue, boolean validate)
  - @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.
  - private boolean isNotValidStringType()
  - @java.lang.Override boolean isNullable()
    
    Returns:
    Returns the nullable.
  - @java.lang.Override boolean isUrl()
    
    Returns:
    Returns the url.
  - @java.lang.SuppressWarnings(value: 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(value: 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(value: 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(value: 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(value: rawtypes) void setRange(groovy.lang.Range range)
    
    Parameters:
    range - The range to set.
  - @java.lang.SuppressWarnings(value: 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.
    Parameters:
    constraintName - The name of the constraint
    Returns:
    true if the constraint is supported
  - 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 Documentation

[Groovy] Class DefaultConstrainedProperty

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

private static final ClassPropertyFetcher PROPERTY_FETCHER

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

private java.util.Map attributes

protected final ConstraintRegistry constraintRegistry

private boolean display

private boolean editable

private java.lang.String format

private java.util.Map<java.lang.String, java.lang.Object> metaConstraints

private int order

private final java.lang.Class<?> owningClass

private boolean password

private final java.lang.String propertyName

private final java.lang.Class<?> propertyType

private java.lang.String widget

Property Detail

java.util.Map attributes

java.util.Map attributes

boolean blank

boolean creditCard

boolean display

boolean editable

boolean email

java.lang.String format

java.util.List inList

java.lang.String matches

java.lang.Comparable max

java.lang.Integer maxSize

java.lang.Comparable min

java.lang.Integer minSize

java.lang.Object notEqual

boolean nullable

int order

final java.lang.Class<?> owningClass

boolean password

final java.lang.String propertyName

final java.lang.Class<?> propertyType

groovy.lang.Range range

groovy.lang.Range size

boolean url

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(value: rawtypes) java.util.Map getAttributes()

@java.lang.Override @java.lang.SuppressWarnings(value: 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(value: rawtypes) groovy.lang.Range getRange()

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

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

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

private Constraint instantiateConstraint(java.lang.String constraintName, java.lang.Object constraintValue, boolean validate)

@java.lang.Override boolean isBlank()

@java.lang.Override boolean isCreditCard()

@java.lang.Override boolean isEmail()

private boolean isNotValidStringType()

@java.lang.Override boolean isNullable()

@java.lang.Override boolean isUrl()

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

void setBlank(boolean blank)

void setCreditCard(boolean creditCard)