org.hibernate.validator.internal.metadata.aggregated

Class ExecutableMetaData

java.lang.Object

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

org.hibernate.validator.internal.metadata.aggregated.ExecutableMetaData

All Implemented Interfaces:

Iterable<MetaConstraint<?>>, ConstraintMetaData

public class ExecutableMetaData
extends AbstractConstraintMetaData

An aggregated view of the constraint related meta data for a given method or constructors and in (case of methods) all the methods in the inheritance hierarchy which it overrides or implements.

Instances are retrieved by creating a ExecutableMetaData.Builder and adding all required ConstrainedExecutable objects to it. Instances are read-only after creation.

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

Author:

Gunnar Morling

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExecutableMetaData.Builder Creates new ExecutableMetaData instances.

Nested classes/interfaces inherited from interface org.hibernate.validator.internal.metadata.aggregated.ConstraintMetaData

ConstraintMetaData.ConstraintMetaDataKind

Method Summary

Methods

Modifier and Type	Method and Description
ElementDescriptor	asDescriptor(boolean defaultGroupSequenceRedefined, List<Class<?>> defaultGroupSequence) Returns this meta data object's corresponding representation in the descriptor model.
void	assertCorrectnessOfMethodParameterConstraints() Checks the parameter constraints of this method for correctness.
boolean	equals(Object obj)
List<ParameterMetaData>	getAllParameterMetaData() Returns meta data for all parameters of the represented executable.
Iterable<MetaConstraint<?>>	getCrossParameterConstraints() Returns the cross-parameter constraints declared for the represented method or constructor.
String	getIdentifier() Returns an identifier for this meta data object, based on the represented executable's name and its parameter types.
ParameterListMetaData	getParameterListMetaData()
ParameterMetaData	getParameterMetaData(int parameterIndex) Returns meta data for the specified parameter of the represented executable.
Class<?>[]	getParameterTypes()
ReturnValueMetaData	getReturnValueMetaData()
int	hashCode()
String	toString()

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

asDescriptors, getConstraints, getKind, getName, getType, isCascading, isConstrained, iterator

Methods inherited from class java.lang.Object

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

Method Detail

assertCorrectnessOfMethodParameterConstraints

public void assertCorrectnessOfMethodParameterConstraints()
                                                   throws ConstraintDeclarationException

Checks the parameter constraints of this method for correctness.

The following rules apply for this check:

• Only the root method of an overridden method in an inheritance hierarchy may be annotated with parameter constraints in order to avoid the strengthening of a method's preconditions by additional parameter constraints defined at sub-types. If the root method itself has no parameter constraints, also no parameter constraints may be added in sub-types.
• If there are multiple root methods for an method in an inheritance hierarchy (e.g. by implementing two interfaces defining the same method) no parameter constraints for this method are allowed at all in order to avoid a strengthening of a method's preconditions in parallel types.

Throws:

ConstraintDeclarationException - In case the represented method has an illegal parameter constraint.

getParameterMetaData

public ParameterMetaData getParameterMetaData(int parameterIndex)

Returns meta data for the specified parameter of the represented executable.

Parameters:

parameterIndex - the index of the parameter

Returns:

Meta data for the specified parameter. Will never be null.

getAllParameterMetaData

public List<ParameterMetaData> getAllParameterMetaData()

Returns meta data for all parameters of the represented executable.

Returns:

A list with parameter meta data. The length corresponds to the number of parameters of the executable represented by this meta data object, so an empty list may be returned (in case of a parameterless executable), but never null.

getParameterTypes

public Class<?>[] getParameterTypes()

getIdentifier

public String getIdentifier()

Returns an identifier for this meta data object, based on the represented executable's name and its parameter types.

Returns:

An identifier for this meta data object.

getCrossParameterConstraints

public Iterable<MetaConstraint<?>> getCrossParameterConstraints()

Returns the cross-parameter constraints declared for the represented method or constructor.

Returns:

the cross-parameter constraints declared for the represented method or constructor. May be empty but will never be null.

getParameterListMetaData

public ParameterListMetaData getParameterListMetaData()

getReturnValueMetaData

public ReturnValueMetaData getReturnValueMetaData()

asDescriptor

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

Description copied from interface: ConstraintMetaData

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

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.

toString

public String toString()

Overrides:

toString in class AbstractConstraintMetaData

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractConstraintMetaData

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractConstraintMetaData