-
- All Superinterfaces:
- ElementDescriptor
- All Known Subinterfaces:
- ConstructorDescriptor, MethodDescriptor
public interface ExecutableDescriptor extends ElementDescriptor
Provides the common functionality ofMethodDescriptor
andConstructorDescriptor
.- Since:
- 1.1
- Author:
- Gunnar Morling
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface javax.validation.metadata.ElementDescriptor
ElementDescriptor.ConstraintFinder
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description ElementDescriptor.ConstraintFinder
findConstraints()
Returns a finder that will always return an emptySet
.Set<ConstraintDescriptor<?>>
getConstraintDescriptors()
Returns an emptySet
.CrossParameterDescriptor
getCrossParameterDescriptor()
Returns a descriptor containing the cross-parameter constraints of this executable.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 of descriptors representing this executable's parameters, in the order of their declaration, including synthetic parameters.ReturnValueDescriptor
getReturnValueDescriptor()
Returns a descriptor for this executable's return value.boolean
hasConstrainedParameters()
Returnstrue
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 (viaValid
) because of at least one cross-parameter constraint Also returnsfalse
if there is no parameter.boolean
hasConstrainedReturnValue()
Returnstrue
if the executable return value is constrained either: because of a constraint on the return value because validation is cascaded on the return value (viaValid
) Also returnsfalse
if there is no return value.boolean
hasConstraints()
Returnsfalse
.-
Methods inherited from interface javax.validation.metadata.ElementDescriptor
getElementClass
-
-
-
-
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 of descriptors representing this executable's parameters, in the order of their declaration, including synthetic parameters.- Returns:
- a list of descriptors representing this executable's
parameters; an empty list will be returned if this executable has
no parameters, but never
null
-
getCrossParameterDescriptor
CrossParameterDescriptor getCrossParameterDescriptor()
Returns a descriptor containing the cross-parameter constraints of this executable.- Returns:
- a descriptor containing the cross-parameter constraints of this executable
-
getReturnValueDescriptor
ReturnValueDescriptor getReturnValueDescriptor()
Returns a descriptor for this executable's return value. An executable without return value will return a descriptor representingvoid
. This descriptor will have no constraint associated.- Returns:
- a descriptor for this executable's return value
-
hasConstrainedParameters
boolean hasConstrainedParameters()
Returnstrue
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
false
if there is no parameter.- Returns:
true
if the executable parameters are constrained
-
hasConstrainedReturnValue
boolean hasConstrainedReturnValue()
Returnstrue
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
)
false
if there is no return value.- Returns:
true
if the executable return value is constrained
-
hasConstraints
boolean hasConstraints()
Returnsfalse
. An executable per se does not host constraints, usegetParameterDescriptors()
,getCrossParameterDescriptor()
andgetReturnValueDescriptor()
to discover constraints.- Specified by:
hasConstraints
in interfaceElementDescriptor
- Returns:
false
-
getConstraintDescriptors
Set<ConstraintDescriptor<?>> getConstraintDescriptors()
Returns an emptySet
. An executable per se does not host constraints, usegetParameterDescriptors()
,getCrossParameterDescriptor()
andgetReturnValueDescriptor()
to discover constraints.- Specified by:
getConstraintDescriptors
in interfaceElementDescriptor
- Returns:
- an empty
Set
-
findConstraints
ElementDescriptor.ConstraintFinder findConstraints()
Returns a finder that will always return an emptySet
. An executable per se does not host constraints, usegetParameterDescriptors()
,getCrossParameterDescriptor()
andgetReturnValueDescriptor()
to discover constraints.- Specified by:
findConstraints
in interfaceElementDescriptor
- Returns:
ConstraintFinder
object
-
-
Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/validation/metadata/ExecutableDescriptor.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.