MethodInfo

java.lang.Object
- org.jboss.jandex.MethodInfo

All Implemented Interfaces:

AnnotationTarget
```
public final class MethodInfo
extends java.lang.Object
implements AnnotationTarget
```
Represents a Java method, constructor, or static initializer.
Thread-Safety
This class is immutable and can be shared between threads without safe publication.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.jboss.jandex.AnnotationTarget
  AnnotationTarget.Kind

Field Summary

Fields
Modifier and Type Field and Description

private ClassInfo clazz

private MethodInternal methodInternal

Fields
Modifier and Type	Field and Description
`private ClassInfo`	`clazz`
`private MethodInternal`	`methodInternal`

Constructor Summary

Constructors
Constructor and Description
`MethodInfo()`
`MethodInfo(ClassInfo clazz, byte[] name, Type[] parameters, Type returnType, short flags)`
`MethodInfo(ClassInfo clazz, MethodInternal methodInternal)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`AnnotationInstance`	`annotation(DotName name)` Retrieves an annotation instance declared on this method, it parameters, or any type within the signature of the method, by the name of the annotation.
`java.util.List<AnnotationInstance>`	`annotations()` Returns the annotation instances declared on this method.
`Type[]`	`args()` Deprecated.
`ClassInfo`	`asClass()` Casts and returns this target as a `ClassInfo` if it is of kind `CLASS`
`FieldInfo`	`asField()` Casts and returns this target as a `FieldInfo` if it is of kind `FIELD`
`MethodInfo`	`asMethod()` Casts and returns this target as a `MethodInfo` if it is of kind `METHOD`
`MethodParameterInfo`	`asMethodParameter()` Casts and returns this target as a `MethodParameterInfo` if it is of kind `METHOD_PARAMETER`
`TypeTarget`	`asType()` Casts and returns this target as a `TypeTarget` if it is of kind `TYPE`
`(package private) Type[]`	`copyExceptions()`
`(package private) Type[]`	`copyParameters()`
`static MethodInfo`	`create(ClassInfo clazz, java.lang.String name, Type[] args, Type returnType, short flags)` Construct a new mock Method instance.
`ClassInfo`	`declaringClass()` Returns the class that declared this method
`java.util.List<Type>`	`exceptions()` Returns the list of throwable classes declared to be thrown by this method.
`short`	`flags()` Returns the access fields of this method.
`boolean`	`hasAnnotation(DotName name)` Returns whether or not the annotation instance with the given name occurs on this method, its parameters or its signature
`AnnotationTarget.Kind`	`kind()` Returns the kind of object this target represents.
`(package private) MethodInternal`	`methodInternal()`
`java.lang.String`	`name()` Returns the name of this method
`java.util.List<Type>`	`parameters()` Returns a list containing the types of all parameters declared on this method, in parameter order.
`Type`	`receiverType()` Returns the receiver type of this method (a declaration of the "this" reference), if specified.
`Type`	`returnType()` Returns this method's return parameter type.
`(package private) void`	`setAnnotations(java.util.List<AnnotationInstance> annotations)`
`(package private) void`	`setClassInfo(ClassInfo clazz)`
`(package private) void`	`setExceptions(Type[] exceptions)`
`(package private) void`	`setMethodInternal(MethodInternal methodInternal)`
`(package private) void`	`setParameters(Type[] parameters)`
`(package private) void`	`setReceiverType(Type receiverType)`
`(package private) void`	`setReturnType(Type returnType)`
`(package private) void`	`setTypeParameters(Type[] typeParameters)`
`java.lang.String`	`toString()` Returns a string representation describing this field.
`(package private) Type[]`	`typeParameterArray()`
`java.util.List<TypeVariable>`	`typeParameters()` Returns the generic type parameters defined by this method.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - methodInternal
```
private MethodInternal methodInternal
```
  - clazz
```
private ClassInfo clazz
```
- Constructor Detail
  - MethodInfo
```
MethodInfo()
```
  - MethodInfo
```
MethodInfo(ClassInfo clazz,
           MethodInternal methodInternal)
```
  - MethodInfo
```
MethodInfo(ClassInfo clazz,
           byte[] name,
           Type[] parameters,
           Type returnType,
           short flags)
```
- Method Detail
  - create
```
public static MethodInfo create(ClassInfo clazz,
                                java.lang.String name,
                                Type[] args,
                                Type returnType,
                                short flags)
```
    Construct a new mock Method instance.
    
    Parameters:
    
    clazz - the class declaring the field
    
    name - the name of the field
    
    args - a read only array containing the types of each parameter in parameter order
    
    returnType - the return value type
    
    flags - the method attributes
    
    Returns:
    
    a mock field
  - name
```
public final java.lang.String name()
```
    Returns the name of this method
    
    Returns:
    
    the name of the method
  - kind
```
public final AnnotationTarget.Kind kind()
```
    Description copied from interface: AnnotationTarget
    
    Returns the kind of object this target represents.
    
    Specified by:
    
    kind in interface AnnotationTarget
    
    Returns:
    
    the target kind.
  - declaringClass
```
public final ClassInfo declaringClass()
```
    Returns the class that declared this method
    
    Returns:
    
    the declaring class
  - args
```
@Deprecated
public final Type[] args()
```
    Deprecated.
    
    Returns an array containing parameter types in parameter order. This method performs a defensive array copy per call, and should be avoided. Instead the parameters() method should be used.
    
    Returns:
    
    an array copy contain parameter types
  - copyParameters
```
final Type[] copyParameters()
```
  - parameters
```
public final java.util.List<Type> parameters()
```
    Returns a list containing the types of all parameters declared on this method, in parameter order. This method may return an empty list, but never null.
    
    Returns:
    
    all parameter types on this method
  - returnType
```
public final Type returnType()
```
    Returns this method's return parameter type. If this method has a void return, a special void type is returned. This method will never return null.
    
    Returns:
    
    the type of this method's return value
  - receiverType
```
public final Type receiverType()
```
    Returns the receiver type of this method (a declaration of the "this" reference), if specified. This is used to convey annotations on the "this" instance.
    
    Returns:
    
    the receiver type of this method
  - exceptions
```
public final java.util.List<Type> exceptions()
```
    Returns the list of throwable classes declared to be thrown by this method. This method may return an empty list, but never null.
    
    Returns:
    
    the list of throwable classes thrown by this method
  - copyExceptions
```
final Type[] copyExceptions()
```
  - typeParameters
```
public final java.util.List<TypeVariable> typeParameters()
```
    Returns the generic type parameters defined by this method. This list will contain resolved type variables which may reference other type parameters, including those declared by the enclosing class of this method.
    
    Returns:
    
    the list of generic type parameters for this method, or an empty list if none
  - annotations
```
public final java.util.List<AnnotationInstance> annotations()
```
    Returns the annotation instances declared on this method. This includes annotations which are defined against method parameters, as well as type annotations declared on any usage within the method signature. The target() of the returned annotation instances may be used to determine the exact location of ths respective annotation instance.
    The following is a non-exhaustive list of examples of annotations returned by this method:
```
     @MyMethodAnnotation
     public void foo() {...}

     public void foo(@MyParamAnnotation int param) {...}

     public void foo(List<@MyTypeAnnotation> list) {...}

     public <@AnotherTypeAnnotation T> void foo(T t) {...}
 
```
    Returns:
    
    the annotation instances declared on this class or its parameters, or an empty list if none
  - annotation
```
public final AnnotationInstance annotation(DotName name)
```
    Retrieves an annotation instance declared on this method, it parameters, or any type within the signature of the method, by the name of the annotation. If an annotation by that name is not present, null will be returned.
    The following is a non-exhaustive list of examples of annotations returned by this method:
```
     @MyMethodAnnotation
     public void foo() {...}

     public void foo(@MyParamAnnotation int param) {...}

     public void foo(List<@MyTypeAnnotation> list) {...}

     public <@AnotherTypeAnnotation T> void foo(T t) {...}
 
```
    Parameters:
    
    name - the name of the annotation to locate within the method
    
    Returns:
    
    the annotation if found, otherwise, null
  - hasAnnotation
```
public final boolean hasAnnotation(DotName name)
```
    Returns whether or not the annotation instance with the given name occurs on this method, its parameters or its signature
    
    Parameters:
    
    name - the name of the annotation to look for
    
    Returns:
    
    true if the annotation is present, false otherwise
    
    See Also:
    
    annotations(), annotation(DotName)
  - flags
```
public final short flags()
```
    Returns the access fields of this method. Modifier can be used on this value.
    
    Returns:
    
    the access flags of this method
  - toString
```
public java.lang.String toString()
```
    Returns a string representation describing this field. It is similar although not necessarily equivalent to a Java source code expression representing this field.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a string representation for this field
  - asClass
```
public final ClassInfo asClass()
```
    Description copied from interface: AnnotationTarget
    
    Casts and returns this target as a ClassInfo if it is of kind CLASS
    
    Specified by:
    
    asClass in interface AnnotationTarget
    
    Returns:
    
    this instance cast to a class
  - asField
```
public final FieldInfo asField()
```
    Description copied from interface: AnnotationTarget
    
    Casts and returns this target as a FieldInfo if it is of kind FIELD
    
    Specified by:
    
    asField in interface AnnotationTarget
    
    Returns:
    
    this instance cast to a field
  - asMethod
```
public final MethodInfo asMethod()
```
    Description copied from interface: AnnotationTarget
    
    Casts and returns this target as a MethodInfo if it is of kind METHOD
    
    Specified by:
    
    asMethod in interface AnnotationTarget
    
    Returns:
    
    this instance cast to a method
  - asMethodParameter
```
public final MethodParameterInfo asMethodParameter()
```
    Description copied from interface: AnnotationTarget
    
    Casts and returns this target as a MethodParameterInfo if it is of kind METHOD_PARAMETER
    
    Specified by:
    
    asMethodParameter in interface AnnotationTarget
    
    Returns:
    
    this instance cast to a method parameter
  - asType
```
public final TypeTarget asType()
```
    Description copied from interface: AnnotationTarget
    
    Casts and returns this target as a TypeTarget if it is of kind TYPE
    
    Specified by:
    
    asType in interface AnnotationTarget
    
    Returns:
    
    this instance cast to a type target
  - methodInternal
```
final MethodInternal methodInternal()
```
  - setMethodInternal
```
final void setMethodInternal(MethodInternal methodInternal)
```
  - setClassInfo
```
final void setClassInfo(ClassInfo clazz)
```
  - typeParameterArray
```
final Type[] typeParameterArray()
```
  - setTypeParameters
```
void setTypeParameters(Type[] typeParameters)
```
  - setParameters
```
void setParameters(Type[] parameters)
```
  - setReturnType
```
void setReturnType(Type returnType)
```
  - setExceptions
```
void setExceptions(Type[] exceptions)
```
  - setReceiverType
```
void setReceiverType(Type receiverType)
```
  - setAnnotations
```
void setAnnotations(java.util.List<AnnotationInstance> annotations)
```

Class MethodInfo

Nested Class Summary

Nested classes/interfaces inherited from interface org.jboss.jandex.AnnotationTarget

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

methodInternal

clazz

Constructor Detail

MethodInfo

MethodInfo

MethodInfo

Method Detail

create

name

kind

declaringClass

args

copyParameters

parameters

returnType

receiverType

exceptions

copyExceptions

typeParameters

annotations

annotation

hasAnnotation

flags

toString

asClass

asField

asMethod

asMethodParameter

asType

methodInternal

setMethodInternal

setClassInfo

typeParameterArray

setTypeParameters

setParameters

setReturnType

setExceptions

setReceiverType

setAnnotations