DefaultConstrainedProperty (Grace Data

grails.gorm.validation.DefaultConstrainedProperty

All Implemented Interfaces and Traits:: ConstrainedProperty

@CompileStatic
@Slf4j
@ToString(includes: [owningClass, propertyType, propertyName, appliedConstraints])
class DefaultConstrainedProperty
extends Object
implements ConstrainedProperty

Default implementation of the ConstrainedProperty interface

Authors:: Graeme Rocher

Since:: 6.0

Field Summary

Fields
Modifiers	Name	Description
`protected Map<String, Constraint>`	`appliedConstraints`
`protected ConstraintRegistry`	`constraintRegistry`

Properties Summary

Properties
Type	Name and description
`Map`	`attributes`
`Map`	`attributes`
`boolean`	`blank`
`boolean`	`creditCard`
`boolean`	`display` whether the property should be displayed
`boolean`	`editable` whether the property is editable
`boolean`	`email`
`String`	`format` the format of the property (for example a date pattern)
`List`	`inList`
`String`	`matches`
`Comparable`	`max`
`Integer`	`maxSize`
`Comparable`	`min`
`Integer`	`minSize`
`Object`	`notEqual`
`boolean`	`nullable`
`int`	`order` The order of the property
`Class<?>`	`owningClass` The owning class
`boolean`	`password` whether the property is a password
`String`	`propertyName` the property name
`Class<?>`	`propertyType` The property type
`Range`	`range`
`Range`	`size`
`boolean`	`url`
`String`	`widget` The widget to use to render the property

Constructor Summary

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

Methods Summary

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

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- Field Detail
  - protected final Map<String, Constraint> appliedConstraints
  - protected final ConstraintRegistry constraintRegistry
- Property Detail
  - Map attributes
  - Map attributes
  - boolean blank
  - boolean creditCard
  - boolean display
    
    whether the property should be displayed
  - boolean editable
    
    whether the property is editable
  - boolean email
  - String format
    
    the format of the property (for example a date pattern)
  - List inList
  - String matches
  - Comparable max
  - Integer maxSize
  - Comparable min
  - Integer minSize
  - Object notEqual
  - boolean nullable
  - int order
    
    The order of the property
  - final Class<?> owningClass
    
    The owning class
  - boolean password
    
    whether the property is a password
  - final String propertyName
    
    the property name
  - final Class<?> propertyType
    
    The property type
  - Range range
  - Range size
  - boolean url
  - String widget
    
    The widget to use to render the property
- Constructor Detail
  - DefaultConstrainedProperty(Class<?> owningClass, String propertyName, 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(String name, Object value)
    
    Adds a meta constraints which is a non-validating informational constraint.
    Parameters:
    name - The name of the constraint
    value - The value
  - @Override
    void applyConstraint(String constraintName, 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(String constraintName, Object constrainingValue)
  - @Override
    Constraint getAppliedConstraint(String name)
    
    Obtains an applied constraint by name.
    Parameters:
    name - The name of the constraint
    Returns:
    The applied constraint
  - @Override
    Collection<Constraint> getAppliedConstraints()
    
    Returns:
    Returns the appliedConstraints.
  - @SuppressWarnings(value: rawtypes)
    Map getAttributes()
  - @Override
    @SuppressWarnings(value: rawtypes)
    List getInList()
    
    Returns:
    Returns the inList.
  - @Override
    String getMatches()
    
    Returns:
    Returns the matches.
  - @Override
    Comparable getMax()
    
    Returns:
    Returns the max.
  - @Override
    Integer getMaxSize()
    
    Returns:
    Returns the maxSize.
  - Object getMetaConstraintValue(String name)
    
    Obtains the value of the named meta constraint.
    Parameters:
    name - The name of the constraint
    Returns:
    The value
  - Map<String, Object> getMetaConstraints()
    
    Returns:
    Returns the metaConstraints.
  - @Override
    Comparable getMin()
    
    Returns:
    Returns the min.
  - @Override
    Integer getMinSize()
    
    Returns:
    Returns the minSize.
  - @Override
    Object getNotEqual()
    
    Returns:
    Returns the notEqual.
  - @Override
    Class getOwner()
  - @Override
    @SuppressWarnings(value: rawtypes)
    Range getRange()
    
    Returns:
    Returns the range.
  - @Override
    Integer getScale()
    
    Returns:
    The scale, if defined for this property; null, otherwise
  - @Override
    @SuppressWarnings(value: rawtypes)
    Range getSize()
    
    Returns:
    Returns the size.
  - @Override
    boolean hasAppliedConstraint(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
  - @Override
    boolean isBlank()
    
    Returns:
    the blank.
  - @Override
    boolean isCreditCard()
    
    Returns:
    Returns the creditCard.
  - @Override
    boolean isEmail()
    
    Returns:
    Returns the email.
  - @Override
    boolean isNullable()
    
    Returns:
    Returns the nullable.
  - @Override
    boolean isUrl()
    
    Returns:
    Returns the url.
  - @SuppressWarnings(value: rawtypes)
    void setAttributes(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.
  - @SuppressWarnings(value: rawtypes)
    void setInList(List inList)
    
    Parameters:
    inList - The inList to set.
  - void setMatches(String regex)
    
    Parameters:
    regex - The matches to set.
  - @SuppressWarnings(value: rawtypes)
    void setMax(Comparable max)
    
    Parameters:
    max - The max to set.
  - void setMaxSize(Integer maxSize)
    
    Parameters:
    maxSize - The maxSize to set.
  - @SuppressWarnings(value: rawtypes)
    void setMin(Comparable min)
    
    Parameters:
    min - The min to set.
  - void setMinSize(Integer minSize)
    
    Parameters:
    minSize - The minLength to set.
  - void setNotEqual(Object notEqual)
    
    Parameters:
    notEqual - The notEqual to set.
  - void setNullable(boolean nullable)
    
    Parameters:
    nullable - The nullable to set.
  - @SuppressWarnings(value: rawtypes)
    void setRange(Range range)
    
    Parameters:
    range - The range to set.
  - @SuppressWarnings(value: rawtypes)
    void setSize(Range size)
    
    Parameters:
    size - The size to set.
  - void setUrl(boolean url)
    
    Parameters:
    url - The url to set.
  - @Override
    boolean supportsContraint(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(Object target, Object propertyValue, 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

protected final Map<String, Constraint> appliedConstraints

protected final ConstraintRegistry constraintRegistry

Property Detail

Map attributes

Map attributes

boolean blank

boolean creditCard

boolean display

boolean editable

boolean email

String format

List inList

String matches

Comparable max

Integer maxSize

Comparable min

Integer minSize

Object notEqual

boolean nullable

int order

final Class<?> owningClass

boolean password

final String propertyName

final Class<?> propertyType

Range range

Range size

boolean url

String widget

Constructor Detail

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

Method Detail

void addMetaConstraint(String name, Object value)

@Overridevoid applyConstraint(String constraintName, Object constrainingValue)

protected void applyConstraintInternal(String constraintName, Object constrainingValue)

@OverrideConstraint getAppliedConstraint(String name)

@OverrideCollection<Constraint> getAppliedConstraints()

@SuppressWarnings(value: rawtypes)Map getAttributes()

@Override@SuppressWarnings(value: rawtypes)List getInList()

@OverrideString getMatches()

@OverrideComparable getMax()

@OverrideInteger getMaxSize()

Object getMetaConstraintValue(String name)

Map<String, Object> getMetaConstraints()

@OverrideComparable getMin()

@OverrideInteger getMinSize()

@OverrideObject getNotEqual()

@OverrideClass getOwner()

@Override@SuppressWarnings(value: rawtypes)Range getRange()

@OverrideInteger getScale()

@Override@SuppressWarnings(value: rawtypes)Range getSize()

@Overrideboolean hasAppliedConstraint(String constraintName)

@Overrideboolean isBlank()

@Overrideboolean isCreditCard()

@Overrideboolean isEmail()

@Overrideboolean isNullable()

@Overrideboolean isUrl()

@SuppressWarnings(value: rawtypes)void setAttributes(Map attributes)

void setBlank(boolean blank)

void setCreditCard(boolean creditCard)

void setEmail(boolean email)

@SuppressWarnings(value: rawtypes)void setInList(List inList)

void setMatches(String regex)

@SuppressWarnings(value: rawtypes)void setMax(Comparable max)

void setMaxSize(Integer maxSize)

@SuppressWarnings(value: rawtypes)void setMin(Comparable min)

void setMinSize(Integer minSize)

void setNotEqual(Object notEqual)

void setNullable(boolean nullable)

@SuppressWarnings(value: rawtypes)void setRange(Range range)

@SuppressWarnings(value: rawtypes)void setSize(Range size)

void setUrl(boolean url)

@Overrideboolean supportsContraint(String constraintName)

void validate(Object target, Object propertyValue, Errors errors)

@Override
void applyConstraint(String constraintName, Object constrainingValue)

@Override
Constraint getAppliedConstraint(String name)

@Override
Collection<Constraint> getAppliedConstraints()

@SuppressWarnings(value: rawtypes)
Map getAttributes()

@Override
@SuppressWarnings(value: rawtypes)
List getInList()

@Override
String getMatches()

@Override
Comparable getMax()

@Override
Integer getMaxSize()

@Override
Comparable getMin()

@Override
Integer getMinSize()

@Override
Object getNotEqual()

@Override
Class getOwner()

@Override
@SuppressWarnings(value: rawtypes)
Range getRange()

@Override
Integer getScale()

@Override
@SuppressWarnings(value: rawtypes)
Range getSize()

@Override
boolean hasAppliedConstraint(String constraintName)

@Override
boolean isBlank()

@Override
boolean isCreditCard()

@Override
boolean isEmail()

@Override
boolean isNullable()

@Override
boolean isUrl()

@SuppressWarnings(value: rawtypes)
void setAttributes(Map attributes)

@SuppressWarnings(value: rawtypes)
void setInList(List inList)

@SuppressWarnings(value: rawtypes)
void setMax(Comparable max)

@SuppressWarnings(value: rawtypes)
void setMin(Comparable min)

@SuppressWarnings(value: rawtypes)
void setRange(Range range)

@SuppressWarnings(value: rawtypes)
void setSize(Range size)

@Override
boolean supportsContraint(String constraintName)