Interface ParameterDescription

All Superinterfaces:

AnnotationSource, ByteCodeElement.TypeDependant<ParameterDescription.InDefinedShape, ParameterDescription.Token>, ModifierReviewable, ModifierReviewable.ForParameterDescription, ModifierReviewable.OfMandatable, NamedElement, NamedElement.WithOptionalName, NamedElement.WithRuntimeName

All Known Subinterfaces:

ParameterDescription.InDefinedShape, ParameterDescription.InGenericShape

All Known Implementing Classes:

ParameterDescription.AbstractBase, ParameterDescription.ForLoadedParameter, ParameterDescription.ForLoadedParameter.OfConstructor, ParameterDescription.ForLoadedParameter.OfLegacyVmConstructor, ParameterDescription.ForLoadedParameter.OfLegacyVmMethod, ParameterDescription.ForLoadedParameter.OfMethod, ParameterDescription.InDefinedShape.AbstractBase, ParameterDescription.Latent, ParameterDescription.TypeSubstituting, Transformer.ForMethod.TransformedMethod.TransformedParameter, TypePool.Default.LazyTypeDescription.LazyMethodDescription.LazyParameterDescription

public interface ParameterDescription
extends AnnotationSource, NamedElement.WithRuntimeName, NamedElement.WithOptionalName, ModifierReviewable.ForParameterDescription, ByteCodeElement.TypeDependant<ParameterDescription.InDefinedShape, ParameterDescription.Token>

Description of the parameter of a Java method or constructor.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ParameterDescription.AbstractBase	A base implementation of a method parameter description.
static class	ParameterDescription.ForLoadedParameter<T extends AccessibleObject>	Description of a loaded parameter with support for the information exposed by java.lang.reflect.Parameter.
static interface	ParameterDescription.InDefinedShape	Represents a parameter in its defined shape, i.e.
static interface	ParameterDescription.InGenericShape	Represents a parameter description in its generic shape, i.e.
static class	ParameterDescription.Latent	A latent description of a parameter that is not attached to a method or constructor.
static class	ParameterDescription.Token	A token representing a parameter's properties detached from a type.
static class	ParameterDescription.TypeSubstituting	A parameter description that represents a given parameter but with a substituted parameter type.

Nested classes/interfaces inherited from interface AnnotationSource

AnnotationSource.Empty, AnnotationSource.Explicit

Nested classes/interfaces inherited from interface ModifierReviewable

ModifierReviewable.ForFieldDescription, ModifierReviewable.ForMethodDescription, ModifierReviewable.ForModuleDescription, ModifierReviewable.ForModuleRequirement, ModifierReviewable.ForParameterDescription, ModifierReviewable.ForTypeDefinition, ModifierReviewable.OfAbstraction, ModifierReviewable.OfByteCodeElement, ModifierReviewable.OfEnumeration, ModifierReviewable.OfMandatable

Nested classes/interfaces inherited from interface NamedElement

NamedElement.WithDescriptor, NamedElement.WithGenericName, NamedElement.WithOptionalName, NamedElement.WithRuntimeName

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME_PREFIX	The prefix for names of an unnamed parameter.

Fields inherited from interface ModifierReviewable

EMPTY_MASK

Fields inherited from interface NamedElement

EMPTY_NAME, NO_NAME

Method Summary

Modifier and Type	Method	Description
MethodDescription	getDeclaringMethod()	Returns the method that declares this parameter.
int	getIndex()	Returns this parameter's index.
int	getOffset()	Returns the offset to the parameter value within the local method variable.
TypeDescription.Generic	getType()	Returns the type of this parameter.
boolean	hasModifiers()	Checks if this parameter has an explicit modifier.

Methods inherited from interface AnnotationSource

getDeclaredAnnotations

Methods inherited from interface ByteCodeElement.TypeDependant

asDefined, asToken

Methods inherited from interface ModifierReviewable

getModifiers, getSyntheticState, isFinal, isSynthetic

Methods inherited from interface ModifierReviewable.ForParameterDescription

getParameterManifestation, getProvisioningState

Methods inherited from interface ModifierReviewable.OfMandatable

getMandate, isMandated

Methods inherited from interface NamedElement

getActualName

Methods inherited from interface NamedElement.WithOptionalName

isNamed

Methods inherited from interface NamedElement.WithRuntimeName

getInternalName, getName

Field Details

NAME_PREFIX

static final String NAME_PREFIX

The prefix for names of an unnamed parameter.

See Also:

• Constant Field Values

Method Details

getType

TypeDescription.Generic getType()

Returns the type of this parameter.

Returns:

The type of this parameter.

getDeclaringMethod

MethodDescription getDeclaringMethod()

Returns the method that declares this parameter.

Returns:

The method that declares this parameter.

getIndex

int getIndex()

Returns this parameter's index.

Returns:

The index of this parameter.

hasModifiers

boolean hasModifiers()

Checks if this parameter has an explicit modifier. A parameter without a modifier is simply treated as if it had a modifier of zero.

Returns:

true if this parameter defines explicit modifiers.

getOffset

int getOffset()

Returns the offset to the parameter value within the local method variable.

Returns:

The offset of this parameter's value.