net.bytebuddy.description.method

Interface ParameterDescription

All Superinterfaces:

AnnotatedCodeElement, ModifierReviewable, NamedElement

All Known Implementing Classes:

InstrumentedType.AbstractBase.MethodToken.ParameterToken, ParameterDescription.AbstractParameterDescription, ParameterDescription.ForLoadedParameter, ParameterDescription.ForLoadedParameter.OfLegacyVmConstructor, ParameterDescription.ForLoadedParameter.OfLegacyVmMethod, ParameterDescription.Latent

public interface ParameterDescription
extends AnnotatedCodeElement, NamedElement, ModifierReviewable

Description of the parameter of a Java method or constructor.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ParameterDescription.AbstractParameterDescription A base implementation of a method parameter description.
static class	ParameterDescription.ForLoadedParameter Description of a loaded parameter, represented by a Java 8 java.lang.reflect.Parameter.
static class	ParameterDescription.Latent A latent description of a parameter that is not attached to a method or constructor.

Nested classes/interfaces inherited from interface net.bytebuddy.description.ModifierReviewable

ModifierReviewable.AbstractModifierReviewable

Field Summary

Fields

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

Fields inherited from interface net.bytebuddy.description.NamedElement

EMPTY_NAME

Fields inherited from interface net.bytebuddy.description.ModifierReviewable

EMPTY_MASK

Method Summary

Modifier and Type	Method and 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	getTypeDescription() Returns the parameter's type.
boolean	hasModifiers() Checks if this parameter has an explicit modifier.
boolean	isNamed() Checks if this parameter has an explicit name.

Methods inherited from interface net.bytebuddy.description.annotation.AnnotatedCodeElement

getDeclaredAnnotations

Methods inherited from interface net.bytebuddy.description.NamedElement

getInternalName, getName, getSourceCodeName

Methods inherited from interface net.bytebuddy.description.ModifierReviewable

getModifiers, isAbstract, isAnnotation, isBridge, isDeprecated, isEnum, isFinal, isInterface, isMandated, isNative, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, isStrict, isSuper, isSynchronized, isSynthetic, isTransient, isVarArgs, isVolatile

Field Detail

NAME_PREFIX

static final String NAME_PREFIX

The prefix for names of an unnamed parameter.

See Also:

Constant Field Values

Method Detail

getTypeDescription

TypeDescription getTypeDescription()

Returns the parameter's type.

Returns:

The parameter's type.

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.

isNamed

boolean isNamed()

Checks if this parameter has an explicit name. A parameter without an explicit name is named implicitly by argX with X denoting the zero-based index.

Returns:

true if the parameter has an explicit name.

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.