Package org.hibernate.validator.internal.metadata.aggregated

Class ReturnValueMetaData

java.lang.Object

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

org.hibernate.validator.internal.metadata.aggregated.ReturnValueMetaData

All Implemented Interfaces:

Iterable<MetaConstraint<?>>, ConstraintMetaData, Cascadable, Validatable

public class ReturnValueMetaData
extends AbstractConstraintMetaData
implements Validatable, Cascadable

Represents the constraint related meta data of the return value of a method or constructor.

Author:

Gunnar Morling

Nested Class Summary

Nested classes/interfaces inherited from interface org.hibernate.validator.internal.metadata.facets.Cascadable

Cascadable.Builder

Constructor Summary

Constructors

Constructor	Description
ReturnValueMetaData(Type type, Set<MetaConstraint<?>> constraints, Set<MetaConstraint<?>> containerElementsConstraints, CascadingMetaData cascadingMetaData)

Method Summary

Modifier and Type	Method	Description
void	appendTo(PathImpl path)	Appends this cascadable element to the given path.
ReturnValueDescriptor	asDescriptor(boolean defaultGroupSequenceRedefined, List<Class<?>> defaultGroupSequence)	Returns this meta data object's corresponding representation in the descriptor model.
Iterable<Cascadable>	getCascadables()	Returns the cascaded elements of this validatable, e.g.
Type	getCascadableType()	Returns the data type of this cascadable, e.g.
CascadingMetaData	getCascadingMetaData()	Returns cascading metadata of this cascadable element.
ConstraintLocation.ConstraintLocationKind	getConstraintLocationKind()	Returns the constraint location kind of the cascadable.
ElementKind	getKind()	Returns the kind of this meta data object.
Object	getValue(Object parent)	Returns the value of this cacadable from the given parent.
boolean	hasCascadables()	Returns true if this validatable has at least one cascadable element, false otherwise.

Methods inherited from class org.hibernate.validator.internal.metadata.aggregated.AbstractConstraintMetaData

asContainerElementTypeDescriptors, asDescriptors, equals, getAllConstraints, getContainerElementsConstraints, getDirectConstraints, getName, getType, hashCode, isCascading, isConstrained, iterator, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ReturnValueMetaData

public ReturnValueMetaData(Type type,
                           Set<MetaConstraint<?>> constraints,
                           Set<MetaConstraint<?>> containerElementsConstraints,
                           CascadingMetaData cascadingMetaData)

Method Detail

getCascadables

public Iterable<Cascadable> getCascadables()

Description copied from interface: Validatable

Returns the cascaded elements of this validatable, e.g. the properties of a bean or the parameters of a method annotated with @Valid.

Specified by:

getCascadables in interface Validatable

Returns:

The cascaded elements of this validatable.

hasCascadables

public boolean hasCascadables()

Description copied from interface: Validatable

Returns true if this validatable has at least one cascadable element, false otherwise.

Specified by:

hasCascadables in interface Validatable

getConstraintLocationKind

public ConstraintLocation.ConstraintLocationKind getConstraintLocationKind()

Description copied from interface: Cascadable

Returns the constraint location kind of the cascadable.

Specified by:

getConstraintLocationKind in interface Cascadable

Returns:

Returns the constraint location kind of the cascadable.

asDescriptor

public ReturnValueDescriptor asDescriptor(boolean defaultGroupSequenceRedefined,
                                          List<Class<?>> defaultGroupSequence)

Description copied from interface: ConstraintMetaData

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

Specified by:

asDescriptor in interface ConstraintMetaData

Parameters:

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

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

Returns:

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

getValue

public Object getValue(Object parent)

Description copied from interface: Cascadable

Returns the value of this cacadable from the given parent.

Specified by:

getValue in interface Cascadable

getCascadableType

public Type getCascadableType()

Description copied from interface: Cascadable

Returns the data type of this cascadable, e.g. the type of a bean property or the return type of a method.

Specified by:

getCascadableType in interface Cascadable

Returns:

This cascadable type.

appendTo

public void appendTo(PathImpl path)

Description copied from interface: Cascadable

Appends this cascadable element to the given path.

Specified by:

appendTo in interface Cascadable

getCascadingMetaData

public CascadingMetaData getCascadingMetaData()

Description copied from interface: Cascadable

Returns cascading metadata of this cascadable element. Also contains the cascading metadata of the potential container element types.

Specified by:

getCascadingMetaData in interface Cascadable

getKind

public ElementKind getKind()

Description copied from interface: ConstraintMetaData

Returns the kind of this meta data object.

Specified by:

getKind in interface ConstraintMetaData

Returns:

The kind of this meta data object.