javax.validation.metadata

Interface MethodDescriptor

All Superinterfaces:

ElementDescriptor

public interface MethodDescriptor
extends ElementDescriptor

Describes a validated method.

Since:

1.1

Author:

Gunnar Morling, Emmanuel Bernard

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 method 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.
String	getName() Returns the name of the method represented by this descriptor.
List<ParameterDescriptor>	getParameterDescriptors() Returns a list with descriptors for this method's parameters.
ReturnValueDescriptor	getReturnValueDescriptor() Returns a descriptor for this method's return value.
boolean	isReturnValueConstrained() Returns true if the method 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, findConstraints, getConstraintDescriptors, getElementClass, getKind, hasConstraints

Method Detail

getName

String getName()

Returns the name of the method represented by this descriptor.

Returns:

The name of the method represented by this descriptor.

getParameterDescriptors

List<ParameterDescriptor> getParameterDescriptors()

Returns a list with descriptors for this method's parameters. The size of this list corresponds to the number of this method's parameters.

Returns:

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

getReturnValueDescriptor

ReturnValueDescriptor getReturnValueDescriptor()

Returns a descriptor for this method's return value.

Returns:

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

areParametersConstrained

boolean areParametersConstrained()

Returns true if the method 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 method parameters are constrained

isReturnValueConstrained

boolean isReturnValueConstrained()

Returns true if the method 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 method return value is constrained