javax.validation.metadata

Interface ExecutableDescriptor

All Superinterfaces:

ElementDescriptor

All Known Subinterfaces:

ConstructorDescriptor, MethodDescriptor

public interface ExecutableDescriptor
extends ElementDescriptor

Provides common functionality of MethodDescriptor and ConstructorDescriptor.

Since:

1.1

Author:

Gunnar Morling

Nested Class Summary

Nested classes/interfaces inherited from interface javax.validation.metadata.ElementDescriptor

ElementDescriptor.ConstraintFinder, ElementDescriptor.Kind

Method Summary

Methods

Modifier and Type	Method and Description
boolean	areParametersConstrained() Returns true if the executable parameters are constrained either: because of a constraint on at least one of the parameters because of a cascade on at least one of the parameters (via @Valid) because of at least one cross-parameter constraint Also returns false if there is no parameter.
ElementDescriptor.ConstraintFinder	findConstraints() Find cross-parameter constraints and potentially restricts them to certain criteria.
Set<ConstraintDescriptor<?>>	getConstraintDescriptors() Return all constraint descriptors for all cross-parameter constraints of this executable or an empty Set if none are present.
String	getName() Returns the method name in case this descriptor represents a method or the non-qualified name of the declaring class in case this descriptor represents a constructor.
List<ParameterDescriptor>	getParameterDescriptors() Returns a list with descriptors representing this executable's parameters, in order of their declaration, including synthetic parameters.
ReturnValueDescriptor	getReturnValueDescriptor() Returns a descriptor for this executable's return value.
boolean	hasConstraints() Whether this executable has any cross-parameter constraints.
boolean	isReturnValueConstrained() Returns true if the executable return value is constrained either: because of a constraint on the return value because validation is cascaded on the return value (via @Valid) Also returns false if there is no return value.

Methods inherited from interface javax.validation.metadata.ElementDescriptor

as, getElementClass, getKind

Method Detail

getName

String getName()

Returns the method name in case this descriptor represents a method or the non-qualified name of the declaring class in case this descriptor represents a constructor.

Returns:

The name of the executable represented by this descriptor.

getParameterDescriptors

List<ParameterDescriptor> getParameterDescriptors()

Returns a list with descriptors representing this executable's parameters, in order of their declaration, including synthetic parameters.

Returns:

A list with descriptors representing this executable's parameters. An empty list will be returned if this executable has no parameters, but never null.

getReturnValueDescriptor

ReturnValueDescriptor getReturnValueDescriptor()

Returns a descriptor for this executable's return value.

Returns:

A descriptor for this executable's return value or null if this executable has no return value.

areParametersConstrained

boolean areParametersConstrained()

Returns true if the executable parameters are constrained either:

• because of a constraint on at least one of the parameters
• because of a cascade on at least one of the parameters (via @Valid)
• because of at least one cross-parameter constraint

Also returns false if there is no parameter.

Returns:

true if the executable parameters are constrained

isReturnValueConstrained

boolean isReturnValueConstrained()

Returns true if the executable return value is constrained either:

• because of a constraint on the return value
• because validation is cascaded on the return value (via @Valid)

Also returns false if there is no return value.

Returns:

true if the executable return value is constrained

hasConstraints

boolean hasConstraints()

Whether this executable has any cross-parameter constraints.

Specified by:

hasConstraints in interface ElementDescriptor

Returns:

true if this executable has at least one cross-parameter constraint, false otherwise.

getConstraintDescriptors

Set<ConstraintDescriptor<?>> getConstraintDescriptors()

Return all constraint descriptors for all cross-parameter constraints of this executable or an empty Set if none are present. In particular, constraints on individual parameters and return value constraints are not returned.

Specified by:

getConstraintDescriptors in interface ElementDescriptor

Returns:

Set of cross-parameter constraint descriptors for this element

findConstraints

ElementDescriptor.ConstraintFinder findConstraints()

Find cross-parameter constraints and potentially restricts them to certain criteria. Neither constraints on individual parameters nor return value constraints are taken into account.

Specified by:

findConstraints in interface ElementDescriptor

Returns:

Constraint finder object.