Represents a (potentially) constrained Java element such as a type, field or method. Such an element has a set of org.hibernate.validator.internal.metadata.core.MetaConstraints and can be marked for a cascaded validation. Furthermore each constrained element has a configuration source which determines its origin.

The hierarchy of constrained elements resembles the physical structure of the represented Java types. In particular it doesn't provide the notion of properties and it doesn't aggregate meta data for overridden elements in an inheritance hierarchy.

Identity of implementations is based on the element location and constraint source. That means that for instance in a set there can be two configurations for one and the same Java field created by two different configuration sources (e.g. via annotation and XML) but not two configurations for the same field originating from one configuration source.

Implementations are strictly read-only.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	ConstrainedElement.ConstrainedElementKind The kind of a `ConstrainedElement`.

Method Summary

Modifier and Type	Method and Description
public CascadingMetaDataBuilder	getCascadingMetaDataBuilder() Returns the cascading metadata (e.g. `Valid` and `ConvertGroup`) for the element and the potential container elements.
public Set<MetaConstraint<?>>	Returns: A set with this constrained element's constraints. May be empty, but never `null`. getConstraints() Returns a set containing the constraints specified for this constrained element.
public ConstrainedElement.ConstrainedElementKind	Returns: The kind of this constrained element. getKind() Returns the kind of this constrained element.
public ConfigurationSource	getSource() Returns the configuration source contributing this constrained element.
public Set<MetaConstraint<?>>	getTypeArgumentConstraints() Returns the type argument constraints of this element, if any.
public boolean	Returns: `True`, if this element is constrained, `false` otherwise. isConstrained() Whether this element is constrained or not.

Inherited from java.lang.Iterable:: forEach iterator spliterator

Method Detail

getCascadingMetaDataBuilder	back to summary
public CascadingMetaDataBuilder getCascadingMetaDataBuilder() Returns the cascading metadata (e.g. `Valid` and `ConvertGroup`) for the element and the potential container elements.

getConstraints back to summary

getConstraints	back to summary
public Set<MetaConstraint<?>> getConstraints() Returns a set containing the constraints specified for this constrained element. Returns:Set<MetaConstraint<?>> A set with this constrained element's constraints. May be empty, but never `null`.

public Set<MetaConstraint<?>> getConstraints()

Returns a set containing the constraints specified for this constrained element.

Returns:Set<MetaConstraint<?>>: A set with this constrained element's constraints. May be empty, but never null.

getKind	back to summary
public ConstrainedElement.ConstrainedElementKind getKind() Returns the kind of this constrained element. Returns:ConstrainedElement.ConstrainedElementKind The kind of this constrained element.

getKind

back to summary

public ConstrainedElement.ConstrainedElementKind getKind()

Returns the kind of this constrained element.

Returns:ConstrainedElement.ConstrainedElementKind: The kind of this constrained element.

getSource	back to summary
public ConfigurationSource getSource() Returns the configuration source contributing this constrained element.

getTypeArgumentConstraints	back to summary
public Set<MetaConstraint<?>> getTypeArgumentConstraints() Returns the type argument constraints of this element, if any.

isConstrained back to summary

isConstrained	back to summary
public boolean isConstrained() Whether this element is constrained or not. This is the case, if this element has at least one constraint or a cascaded validation shall be performed for it. Returns:boolean `True`, if this element is constrained, `false` otherwise.

public boolean isConstrained()

Whether this element is constrained or not. This is the case, if this element has at least one constraint or a cascaded validation shall be performed for it.

Returns:boolean: True, if this element is constrained, false otherwise.

org.hibernate.validator.internal.metadata.raw back to summary

public final Enum ConstrainedElement.ConstrainedElementKind

Class Inheritance

extends Enum<ConstrainedElement.ConstrainedElementKind>

java.lang.Object
java.lang.Enum
org.hibernate.validator.internal.metadata.raw.ConstrainedElement.ConstrainedElementKind

The kind of a ConstrainedElement. Can be used to determine an element's type when traversing over a collection of constrained elements.

Author: Gunnar Morling

Field Summary

Modifier and Type	Field and Description
public static final ConstrainedElement.ConstrainedElementKind	CONSTRUCTOR
public static final ConstrainedElement.ConstrainedElementKind	FIELD
public static final ConstrainedElement.ConstrainedElementKind	GETTER
public static final ConstrainedElement.ConstrainedElementKind	METHOD
public static final ConstrainedElement.ConstrainedElementKind	PARAMETER
public static final ConstrainedElement.ConstrainedElementKind	TYPE

Constructor Summary

Access	Constructor and Description
private	ConstrainedElementKind()

Method Summary

Modifier and Type	Method and Description
public boolean	isExecutable()
public boolean	isMethod()
public static ConstrainedElement.ConstrainedElementKind	valueOf(String name)
public static ConstrainedElement.ConstrainedElementKind[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

CONSTRUCTOR	back to summary
public static final ConstrainedElement.ConstrainedElementKind CONSTRUCTOR

FIELD	back to summary
public static final ConstrainedElement.ConstrainedElementKind FIELD

GETTER	back to summary
public static final ConstrainedElement.ConstrainedElementKind GETTER

METHOD	back to summary
public static final ConstrainedElement.ConstrainedElementKind METHOD

PARAMETER	back to summary
public static final ConstrainedElement.ConstrainedElementKind PARAMETER

TYPE	back to summary
public static final ConstrainedElement.ConstrainedElementKind TYPE

Constructor Detail

ConstrainedElementKind	back to summary
private ConstrainedElementKind()

Method Detail

isExecutable	back to summary
public boolean isExecutable()

isMethod	back to summary
public boolean isMethod()

valueOf	back to summary
public static ConstrainedElement.ConstrainedElementKind valueOf(String name)

values	back to summary
public static ConstrainedElement.ConstrainedElementKind[] values()

public Interface ConstrainedElement

Nested and Inner Type Summary

Method Summary

Method Detail

public final Enum ConstrainedElement.ConstrainedElementKind

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail