Top Description Inners Fields Constructors Methods
org.hibernate.validator.internal.metadata.aggregated

public Class PropertyMetaData

extends AbstractConstraintMetaData
Class Inheritance
Imports
java.lang.invoke.MethodHandles, java.lang.reflect.Type, java.util.ArrayDeque, .Collections, .Deque, .EnumSet, .HashMap, .List, .Map, .Objects, .Set, java.util.stream.Collectors, jakarta.validation.ElementKind, org.hibernate.validator.internal.engine.ConstraintCreationContext, org.hibernate.validator.internal.metadata.core.MetaConstraint, .MetaConstraints, org.hibernate.validator.internal.metadata.descriptor.PropertyDescriptorImpl, org.hibernate.validator.internal.metadata.facets.Cascadable, org.hibernate.validator.internal.metadata.location.ConstraintLocation, .GetterConstraintLocation, .TypeArgumentConstraintLocation, org.hibernate.validator.internal.metadata.raw.ConstrainedElement, .ConstrainedElement.ConstrainedElementKind, .ConstrainedExecutable, .ConstrainedField, org.hibernate.validator.internal.properties.Getter, .Property, org.hibernate.validator.internal.properties.javabean.JavaBeanGetter, org.hibernate.validator.internal.util.CollectionHelper, org.hibernate.validator.internal.util.logging.Log, .LoggerFactory, org.hibernate.validator.internal.util.stereotypes.Immutable

Represents the constraint related meta data for a JavaBeans property. Abstracts from the concrete physical type of the underlying Java element(s) (fields or getter methods).

In order to provide a unified access to all JavaBeans constraints also class-level constraints are represented by this meta data type.

Identity is solely based on the property name, hence sets and similar collections of this type may only be created in the scope of one Java type.

Authors
Gunnar Morling, Guillaume Smet

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
private final Set<Cascadable>
private static final Log

Constructor Summary

AccessConstructor and Description
private
PropertyMetaData(String propertyName, Type type, Set<MetaConstraint<?>> constraints, Set<MetaConstraint<?>> containerElementsConstraints, Set<Cascadable> cascadables)

Method Summary

Modifier and TypeMethod and Description
public PropertyDescriptorImpl
asDescriptor(boolean
Whether the bean hosting the represented element has a redefined default group sequence or not.
defaultGroupSequenceRedefined
,
List<Class<?>>
The default group sequence of the bean hosting the represented element.
defaultGroupSequence
)

Implements org.hibernate.validator.internal.metadata.aggregated.ConstraintMetaData.asDescriptor.

Returns this meta data object's corresponding representation in the descriptor model.
public boolean
equals(Object
the reference object with which to compare.
obj
)

Overrides org.hibernate.validator.internal.metadata.aggregated.AbstractConstraintMetaData.equals.

Indicates whether some other object is "equal to" this one.
public Set<Cascadable>
getCascadables()

Returns the cascadables of this property, if any.

public ElementKind
public int
public String
Inherited from org.hibernate.validator.internal.metadata.aggregated.AbstractConstraintMetaData:
asContainerElementTypeDescriptorsasDescriptorsgetAllConstraintsgetContainerElementsConstraintsgetDirectConstraintsgetNamegetTypeisCascadingisConstrainediterator

Field Detail

cascadablesback to summary
private final Set<Cascadable> cascadables
Annotations
@Immutable
LOGback to summary
private static final Log LOG

Constructor Detail

PropertyMetaDataback to summary
private PropertyMetaData(String propertyName, Type type, Set<MetaConstraint<?>> constraints, Set<MetaConstraint<?>> containerElementsConstraints, Set<Cascadable> cascadables)

Method Detail

asDescriptorback to summary
public PropertyDescriptorImpl asDescriptor(boolean defaultGroupSequenceRedefined, List<Class<?>> defaultGroupSequence)

Implements org.hibernate.validator.internal.metadata.aggregated.ConstraintMetaData.asDescriptor.

Doc from org.hibernate.validator.internal.metadata.aggregated.ConstraintMetaData.asDescriptor.

Returns this meta data object's corresponding representation in the descriptor model.

Parameters
defaultGroupSequenceRedefined:boolean

Whether the bean hosting the represented element has a redefined default group sequence or not.

defaultGroupSequence:List<Class<?>>

The default group sequence of the bean hosting the represented element.

Returns:PropertyDescriptorImpl

This meta data object's corresponding descriptor model representation. Implementations should return a specific sub type of ElementDescriptor.

Annotations
@Override
equalsback to summary
public boolean equals(Object obj)

Overrides org.hibernate.validator.internal.metadata.aggregated.AbstractConstraintMetaData.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getCascadablesback to summary
public Set<Cascadable> getCascadables()

Returns the cascadables of this property, if any. Often, there will be just a single element returned. Several elements may be returned in the following cases:

  • a property's field has been marked with @Valid but type-level constraints have been given on the getter
  • one type parameter of a property has been marked with @Valid on the field (e.g. a map's key) but another type parameter has been marked with @Valid on the property (e.g. the map's value)
  • a (shaded) private field in a super-type and another field of the same name in a sub-type are both marked with @Valid
getKindback to summary
public ElementKind getKind()

Implements org.hibernate.validator.internal.metadata.aggregated.ConstraintMetaData.getKind.

Doc from org.hibernate.validator.internal.metadata.aggregated.ConstraintMetaData.getKind.

Returns the kind of this meta data object.

Returns:ElementKind

The kind of this meta data object.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides org.hibernate.validator.internal.metadata.aggregated.AbstractConstraintMetaData.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

Annotations
@Override
toStringback to summary
public String toString()

Overrides org.hibernate.validator.internal.metadata.aggregated.AbstractConstraintMetaData.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override
org.hibernate.validator.internal.metadata.aggregated back to summary

public Class PropertyMetaData.Builder

extends MetaDataBuilder
Class Inheritance

Field Summary

Modifier and TypeField and Description
private final Map<Property, Cascadable.Builder>
private final String
private final Type
private static final EnumSet<ConstrainedElement.ConstrainedElementKind>
Inherited from org.hibernate.validator.internal.metadata.aggregated.MetaDataBuilder:
constraintCreationContext

Constructor Summary

AccessConstructor and Description
public
Builder(Class<?> beanClass, ConstrainedField constrainedProperty, ConstraintCreationContext constraintCreationContext)

public
Builder(Class<?> beanClass, ConstrainedExecutable constrainedMethod, ConstraintCreationContext constraintCreationContext)

Method Summary

Modifier and TypeMethod and Description
public boolean
accepts(ConstrainedElement
The element to check.
constrainedElement
)

Implements abstract org.hibernate.validator.internal.metadata.aggregated.MetaDataBuilder.accepts.

Whether this builder allows to add the given element or not.
protected Set<MetaConstraint<?>>
adaptConstraints(ConstrainedElement constrainedElement, Set<MetaConstraint<?>> constraints)

Overrides org.hibernate.validator.internal.metadata.aggregated.MetaDataBuilder.adaptConstraints.

Allows specific sub-classes to customize the retrieved constraints.
public final void
add(ConstrainedElement
The element to add.
constrainedElement
)

Overrides org.hibernate.validator.internal.metadata.aggregated.MetaDataBuilder.add.

Adds the given element to this builder.
public PropertyMetaData
build()

Implements abstract org.hibernate.validator.internal.metadata.aggregated.MetaDataBuilder.build.

Creates a new, read-only ConstraintMetaData object with all constraint information related to the method or property represented by this builder.
private Property
private String
getPropertyName(ConstrainedElement constrainedElement)

private MetaConstraint<?>
withGetterLocation(ConstraintLocation getterConstraintLocation, MetaConstraint<?> constraint)

Inherited from org.hibernate.validator.internal.metadata.aggregated.MetaDataBuilder:
adaptOriginsAndImplicitGroupsgetBeanClassgetContainerElementConstraintsgetDirectConstraintsisCascading

Field Detail

cascadableBuildersback to summary
private final Map<Property, Cascadable.Builder> cascadableBuilders
propertyNameback to summary
private final String propertyName
propertyTypeback to summary
private final Type propertyType
SUPPORTED_ELEMENT_KINDSback to summary
private static final EnumSet<ConstrainedElement.ConstrainedElementKind> SUPPORTED_ELEMENT_KINDS

Constructor Detail

Builderback to summary
public Builder(Class<?> beanClass, ConstrainedField constrainedProperty, ConstraintCreationContext constraintCreationContext)
Builderback to summary
public Builder(Class<?> beanClass, ConstrainedExecutable constrainedMethod, ConstraintCreationContext constraintCreationContext)

Method Detail

acceptsback to summary
public boolean accepts(ConstrainedElement constrainedElement)

Implements abstract org.hibernate.validator.internal.metadata.aggregated.MetaDataBuilder.accepts.

Doc from org.hibernate.validator.internal.metadata.aggregated.MetaDataBuilder.accepts.

Whether this builder allows to add the given element or not. This is the case if the specified element relates to the same property or method with which this builder was instantiated.

Parameters
constrainedElement:ConstrainedElement

The element to check.

Returns:boolean

true if the given element can be added to this builder, false otherwise.

Annotations
@Override
adaptConstraintsback to summary
protected Set<MetaConstraint<?>> adaptConstraints(ConstrainedElement constrainedElement, Set<MetaConstraint<?>> constraints)

Overrides org.hibernate.validator.internal.metadata.aggregated.MetaDataBuilder.adaptConstraints.

Doc from org.hibernate.validator.internal.metadata.aggregated.MetaDataBuilder.adaptConstraints.

Allows specific sub-classes to customize the retrieved constraints.

Annotations
@Override
addback to summary
public final void add(ConstrainedElement constrainedElement)

Overrides org.hibernate.validator.internal.metadata.aggregated.MetaDataBuilder.add.

Doc from org.hibernate.validator.internal.metadata.aggregated.MetaDataBuilder.add.

Adds the given element to this builder. It must be checked with accepts(ConstrainedElement) before, whether this is allowed or not.

Parameters
constrainedElement:ConstrainedElement

The element to add.

Annotations
@Override
buildback to summary
public PropertyMetaData build()

Implements abstract org.hibernate.validator.internal.metadata.aggregated.MetaDataBuilder.build.

Doc from org.hibernate.validator.internal.metadata.aggregated.MetaDataBuilder.build.

Creates a new, read-only ConstraintMetaData object with all constraint information related to the method or property represented by this builder.

Returns:PropertyMetaData

A ConstraintMetaData object.

Annotations
@Override
getConstrainableFromConstrainedElementback to summary
private Property getConstrainableFromConstrainedElement(ConstrainedElement constrainedElement)
getPropertyNameback to summary
private String getPropertyName(ConstrainedElement constrainedElement)
withGetterLocationback to summary
private MetaConstraint<?> withGetterLocation(ConstraintLocation getterConstraintLocation, MetaConstraint<?> constraint)