Top Description Fields Constructors Methods
org.hibernate.validator.internal.metadata.raw

public abstract Class AbstractConstrainedElement

extends Object
implements ConstrainedElement
Class Inheritance
All Implemented Interfaces
org.hibernate.validator.internal.metadata.raw.ConstrainedElement, java.lang.Iterable
Known Direct Subclasses
org.hibernate.validator.internal.metadata.raw.ConstrainedExecutable, org.hibernate.validator.internal.metadata.raw.ConstrainedField, org.hibernate.validator.internal.metadata.raw.ConstrainedParameter, org.hibernate.validator.internal.metadata.raw.ConstrainedType
Imports
java.util.Collections, .Iterator, .Set, org.hibernate.validator.internal.metadata.aggregated.CascadingMetaDataBuilder, org.hibernate.validator.internal.metadata.core.MetaConstraint, org.hibernate.validator.internal.util.CollectionHelper, org.hibernate.validator.internal.util.stereotypes.Immutable
Base implementation of with functionality common to all ConstrainedElement implementations.
Authors
Gunnar Morling, Hardy Ferentschik

Field Summary

Modifier and TypeField and Description
protected final CascadingMetaDataBuilder
cascadingMetaDataBuilder

protected final Set<MetaConstraint<?>>
constraints

private final ConstrainedElement.ConstrainedElementKind
kind

protected final ConfigurationSource
source

protected final Set<MetaConstraint<?>>
typeArgumentConstraints

Constructor Summary

AccessConstructor and Description
public
AbstractConstrainedElement(ConfigurationSource source, ConstrainedElement.ConstrainedElementKind kind, Set<MetaConstraint<?>> constraints, Set<MetaConstraint<?>> typeArgumentConstraints, CascadingMetaDataBuilder cascadingMetaDataBuilder)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
obj)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public CascadingMetaDataBuilder
getCascadingMetaDataBuilder()

Implements org.hibernate.validator.internal.metadata.raw.ConstrainedElement.getCascadingMetaDataBuilder.

Returns the cascading metadata (e.g. Valid and ConvertGroup) for the element and the potential container elements.
public Set<MetaConstraint<?>>
getConstraints()

Implements org.hibernate.validator.internal.metadata.raw.ConstrainedElement.getConstraints.

Returns a set containing the constraints specified for this constrained element.
public ConstrainedElement.ConstrainedElementKind
getKind()

Implements org.hibernate.validator.internal.metadata.raw.ConstrainedElement.getKind.

Returns the kind of this constrained element.
public ConfigurationSource
getSource()

Implements org.hibernate.validator.internal.metadata.raw.ConstrainedElement.getSource.

Returns the configuration source contributing this constrained element.
public Set<MetaConstraint<?>>
getTypeArgumentConstraints()

Implements org.hibernate.validator.internal.metadata.raw.ConstrainedElement.getTypeArgumentConstraints.

Returns the type argument constraints of this element, if any.
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public boolean
isConstrained()

Implements org.hibernate.validator.internal.metadata.raw.ConstrainedElement.isConstrained.

Whether this element is constrained or not.
public Iterator<MetaConstraint<?>>
iterator()

Implements java.lang.Iterable.iterator.

Returns an iterator over elements of type T.
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

cascadingMetaDataBuilderback to summary
protected final CascadingMetaDataBuilder cascadingMetaDataBuilder
constraintsback to summary
protected final Set<MetaConstraint<?>> constraints
Annotations
@Immutable
kindback to summary
private final ConstrainedElement.ConstrainedElementKind kind
sourceback to summary
protected final ConfigurationSource source
typeArgumentConstraintsback to summary
protected final Set<MetaConstraint<?>> typeArgumentConstraints
Annotations
@Immutable

Constructor Detail

AbstractConstrainedElementback to summary
public AbstractConstrainedElement(ConfigurationSource source, ConstrainedElement.ConstrainedElementKind kind, Set<MetaConstraint<?>> constraints, Set<MetaConstraint<?>> typeArgumentConstraints, CascadingMetaDataBuilder cascadingMetaDataBuilder)

Method Detail

equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.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
getCascadingMetaDataBuilderback to summary
public CascadingMetaDataBuilder getCascadingMetaDataBuilder()

Implements org.hibernate.validator.internal.metadata.raw.ConstrainedElement.getCascadingMetaDataBuilder.

Doc from org.hibernate.validator.internal.metadata.raw.ConstrainedElement.getCascadingMetaDataBuilder.

Returns the cascading metadata (e.g. Valid and ConvertGroup) for the element and the potential container elements.

Annotations
@Override
getConstraintsback to summary
public Set<MetaConstraint<?>> getConstraints()

Implements org.hibernate.validator.internal.metadata.raw.ConstrainedElement.getConstraints.

Doc from org.hibernate.validator.internal.metadata.raw.ConstrainedElement.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.

Annotations
@Override
getKindback to summary
public ConstrainedElement.ConstrainedElementKind getKind()

Implements org.hibernate.validator.internal.metadata.raw.ConstrainedElement.getKind.

Doc from org.hibernate.validator.internal.metadata.raw.ConstrainedElement.getKind.

Returns the kind of this constrained element.

Returns:ConstrainedElement.ConstrainedElementKind

The kind of this constrained element.

Annotations
@Override
getSourceback to summary
public ConfigurationSource getSource()

Implements org.hibernate.validator.internal.metadata.raw.ConstrainedElement.getSource.

Doc from org.hibernate.validator.internal.metadata.raw.ConstrainedElement.getSource.

Returns the configuration source contributing this constrained element.

Annotations
@Override
getTypeArgumentConstraintsback to summary
public Set<MetaConstraint<?>> getTypeArgumentConstraints()

Implements org.hibernate.validator.internal.metadata.raw.ConstrainedElement.getTypeArgumentConstraints.

Doc from org.hibernate.validator.internal.metadata.raw.ConstrainedElement.getTypeArgumentConstraints.

Returns the type argument constraints of this element, if any.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.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
isConstrainedback to summary
public boolean isConstrained()

Implements org.hibernate.validator.internal.metadata.raw.ConstrainedElement.isConstrained.

Doc from org.hibernate.validator.internal.metadata.raw.ConstrainedElement.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.

Annotations
@Override
iteratorback to summary
public Iterator<MetaConstraint<?>> iterator()

Implements java.lang.Iterable.iterator.

Doc from java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

Returns:Iterator<MetaConstraint<?>>

an Iterator.

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override