ArMethod

java.lang.Object
- com.bluegosling.apt.reflect.ArMethod

All Implemented Interfaces:

ArAnnotatedConstruct, ArAnnotatedElement, ArExecutableMember, ArGenericDeclaration, ArMember
```
public class ArMethod
extends Object
```
A method. This is analogous to Method, except that it represents methods in Java source (during annotation processing) vs. representing methods of runtime types.

See Also:

Method, ExecutableElement

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`E`	`asElement()` Returns the underlying `Element` for this object.
`boolean`	`equals(Object o)`
`static ArMethod`	`forElement(ExecutableElement element)` Returns a method based on the specified element.
`ArAnnotation`	`getAnnotation(ArClass annotationClass)` Gets the annotation from the object that corresponds to the specified annotation type.
`ArAnnotation`	`getAnnotation(Class<? extends Annotation> annotationClass)` Gets the annotation from the object that corresponds to the specified annotation type.
`<T extends Annotation> T`	`getAnnotationBridge(Class<T> annotationClass)` Gets an annotation bridge for the specified annotation type.
`List<ArAnnotation>`	`getAnnotations()` Gets all annotations for this object.
`List<ArAnnotation>`	`getDeclaredAnnotations()` Gets the annotations declared on this object.
`ArClass`	`getDeclaringClass()` Returns the class which declared this member.
`Object`	`getDefaultValue()` Returns the default value for an annotation method.
`List<ArClass>`	`getExceptionTypes()` Returns the list of declared exception types that can be thrown by this executable member.
`List<ArType>`	`getGenericExceptionTypes()` Returns the list of declared exception types that can be thrown by this executable memebr.
`List<ArType>`	`getGenericParameterTypes()` Returns the list of parameter types.
`ArType`	`getGenericReturnType()` Returns the method's return type.
`EnumSet<ArModifier>`	`getModifiers()` Returns the modifiers that apply to this member.
`String`	`getName()` Returns the member's name.
`List<List<ArAnnotation>>`	`getParameterAnnotations()` Returns lists of parameter annotations, one list for each parameter.
`List<ArParameter<ArMethod>>`	`getParameters()` Returns the method's list of parameters.
`List<ArClass>`	`getParameterTypes()` Returns the list of parameter types.
`ArType`	`getReceiverType()` Returns the method's receiver type or `null` if the method is static.
`ArClass`	`getReturnType()` Returns the method's return type.
`List<ArTypeParameter<ArMethod>>`	`getTypeParameters()` Returns the method's list of type variables.
`int`	`hashCode()`
`boolean`	`isAnnotationPresent(ArClass annotationClass)` Determines whether an annotation of the specified type exists on the object.
`boolean`	`isAnnotationPresent(Class<? extends Annotation> annotationClass)` Determines whether an annotation of the specified type exists on the object.
`boolean`	`isVarArgs()` Determines whether this executable member can be invoked with variable arity (aka var-args).
`String`	`toString()`

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

Methods inherited from interface com.bluegosling.apt.reflect.ArMember
getDeclaringClass, getModifiers, getName

Methods inherited from interface com.bluegosling.apt.reflect.ArAnnotatedConstruct
getAnnotation, getAnnotation, getAnnotationBridge, getDeclaredAnnotations, isAnnotationPresent, isAnnotationPresent

- Method Detail
  - forElement
```
public static ArMethod forElement(ExecutableElement element)
```
    Returns a method based on the specified element.
    
    Parameters:
    
    element - the element
    
    Returns:
    
    a method
    
    Throws:
    
    NullPointerException - if the specified element is null
    
    IllegalArgumentException - if the specified element does not represent a method
  - getTypeParameters
```
public List<ArTypeParameter<ArMethod>> getTypeParameters()
```
    Returns the method's list of type variables. This is the same as getTypeParameters(), except that the return value has more generic type information.
    
    Specified by:
    
    getTypeParameters in interface ArGenericDeclaration
    
    Returns:
    
    the list of type variables
  - getParameters
```
public List<ArParameter<ArMethod>> getParameters()
```
    Returns the method's list of parameters. This is the same as getParameters(), except that the return value has more generic type information.
    
    Specified by:
    
    getParameters in interface ArExecutableMember
    
    Returns:
    
    the list of parameters
    
    See Also:
    
    Executable.getParameters(), ExecutableElement.getParameters()
  - getReturnType
```
public ArClass getReturnType()
```
    Returns the method's return type. The returned type is a raw type with any generic type information erased. For full type information, use getGenericReturnType().
    
    Returns:
    
    the method's return type
    
    See Also:
    
    Method.getReturnType()
  - getGenericReturnType
```
public ArType getGenericReturnType()
```
    Returns the method's return type. The returned type includes all generic type information that was specified in the source declaration of the type.
    
    Returns:
    
    the method's return type
    
    See Also:
    
    Method.getGenericReturnType(), ExecutableElement.getReturnType()
  - getReceiverType
```
public ArType getReceiverType()
```
    Returns the method's receiver type or null if the method is static. The type of the receiver is always the type of declaring class. This method can be used to extract type annotations that are declared for the method receiver.
    
    Returns:
    
    the method's receiver type
    
    See Also:
    
    Executable.getAnnotatedReceiverType(), ExecutableElement.getReceiverType()
  - getDefaultValue
```
public Object getDefaultValue()
```
    Returns the default value for an annotation method. If this method is not an annotation method then null is returned.
    The type of the value is the same as found in the map returned by ArAnnotation.getAnnotationAttributes().
    
    Returns:
    
    the default value for this annotation method or null if this is not an annotation method
    
    See Also:
    
    Method.getDefaultValue(), ExecutableElement.getDefaultValue()
  - getParameterTypes
```
public List<ArClass> getParameterTypes()
```
    Description copied from interface: ArExecutableMember
    
    Returns the list of parameter types. The returned types are raw types with any generic type information erased. For full type information, use ArExecutableMember.getGenericParameterTypes().
    
    Specified by:
    
    getParameterTypes in interface ArExecutableMember
    
    Returns:
    
    the list of parameter types
    
    See Also:
    
    Executable.getParameterTypes()
  - getGenericParameterTypes
```
public List<ArType> getGenericParameterTypes()
```
    Description copied from interface: ArExecutableMember
    
    Returns the list of parameter types. The returned types include all generic type information that was specified in the source declaration of the type.
    
    Specified by:
    
    getGenericParameterTypes in interface ArExecutableMember
    
    Returns:
    
    the list of parameter types
    
    See Also:
    
    Executable.getGenericParameterTypes()
  - isVarArgs
```
public boolean isVarArgs()
```
    Description copied from interface: ArExecutableMember
    
    Determines whether this executable member can be invoked with variable arity (aka var-args). If so, then the last parameter type must be an array into which the var-args are assembled prior to dispatch.
    
    Specified by:
    
    isVarArgs in interface ArExecutableMember
    
    Returns:
    
    true if this member has variable arity; false otherwise
    
    See Also:
    
    Executable.isVarArgs()
  - getParameterAnnotations
```
public List<List<ArAnnotation>> getParameterAnnotations()
```
    Description copied from interface: ArExecutableMember
    
    Returns lists of parameter annotations, one list for each parameter. If there are no parameters then an empty list is returned. Otherwise, the annotations are returned as a list of lists, with one list corresponding to each parameter. If a given parameter has no annotations then the list corresponding to that parameter will be empty.
    
    Specified by:
    
    getParameterAnnotations in interface ArExecutableMember
    
    Returns:
    
    the list of lists of annotations
    
    See Also:
    
    Executable.getParameterAnnotations()
  - getExceptionTypes
```
public List<ArClass> getExceptionTypes()
```
    Description copied from interface: ArExecutableMember
    
    Returns the list of declared exception types that can be thrown by this executable member. The returned types are raw types with any generic type information erased. For full type information, use ArExecutableMember.getGenericExceptionTypes().
    
    Specified by:
    
    getExceptionTypes in interface ArExecutableMember
    
    Returns:
    
    the list of parameter types
    
    See Also:
    
    Executable.getExceptionTypes()
  - getGenericExceptionTypes
```
public List<ArType> getGenericExceptionTypes()
```
    Description copied from interface: ArExecutableMember
    
    Returns the list of declared exception types that can be thrown by this executable memebr. The returned types include all generic type information that was specified in the source declaration of the type.
    
    Specified by:
    
    getGenericExceptionTypes in interface ArExecutableMember
    
    Returns:
    
    the list of exception types
    
    See Also:
    
    Executable.getGenericExceptionTypes(), ExecutableElement.getThrownTypes()
  - equals
```
public boolean equals(Object o)
```
  - hashCode
```
public int hashCode()
```
  - toString
```
public String toString()
```
  - getDeclaringClass
```
public ArClass getDeclaringClass()
```
    Description copied from interface: ArMember
    
    Returns the class which declared this member.
    
    Specified by:
    
    getDeclaringClass in interface ArMember
    
    Returns:
    
    the class in which this member was declared
    
    See Also:
    
    Member.getDeclaringClass()
  - getModifiers
```
public EnumSet<ArModifier> getModifiers()
```
    Description copied from interface: ArMember
    
    Returns the modifiers that apply to this member. Intentionally unlike java.lang.reflect.Member.getModifiers(), this returns a set of modifiers (defined in an enum) instead of a bitmasked integer.
    
    Specified by:
    
    getModifiers in interface ArMember
    
    Returns:
    
    the modifiers for this member
    
    See Also:
    
    Member.getModifiers()
  - getName
```
public String getName()
```
    Description copied from interface: ArMember
    
    Returns the member's name.
    
    Specified by:
    
    getName in interface ArMember
    
    Returns:
    
    the member's name
  - getAnnotations
```
public List<ArAnnotation> getAnnotations()
```
    Description copied from interface: ArAnnotatedConstruct
    
    Gets all annotations for this object. This includes both annotations declared on the object as well as any inherited annotations.
    
    Specified by:
    
    getAnnotations in interface ArAnnotatedConstruct
    
    Returns:
    
    the list of annotations
  - asElement
```
public E asElement()
```
    Description copied from interface: ArAnnotatedElement
    
    Returns the underlying Element for this object.
    
    Specified by:
    
    asElement in interface ArAnnotatedElement
    
    Returns:
    
    the underlying element
  - getAnnotation
```
public ArAnnotation getAnnotation(ArClass annotationClass)
```
    Description copied from interface: ArAnnotatedConstruct
    
    Gets the annotation from the object that corresponds to the specified annotation type. This will return an inherited annotation if one exists.
    
    Specified by:
    
    getAnnotation in interface ArAnnotatedConstruct
    
    Parameters:
    
    annotationClass - the annotation type
    
    Returns:
    
    the corresponding annotation or null if there is no such annotation
  - getAnnotation
```
public ArAnnotation getAnnotation(Class<? extends Annotation> annotationClass)
```
    Description copied from interface: ArAnnotatedConstruct
    
    Gets the annotation from the object that corresponds to the specified annotation type. This will return an inherited annotation if one exists.
    
    Specified by:
    
    getAnnotation in interface ArAnnotatedConstruct
    
    Parameters:
    
    annotationClass - the annotation type
    
    Returns:
    
    the corresponding annotation or null if there is no such annotation
  - getAnnotationBridge
```
public <T extends Annotation> T getAnnotationBridge(Class<T> annotationClass)
```
    Description copied from interface: ArAnnotatedConstruct
    
    Gets an annotation bridge for the specified annotation type.
    
    Specified by:
    
    getAnnotationBridge in interface ArAnnotatedConstruct
    
    Type Parameters:
    
    T - the type of the annotation
    
    Parameters:
    
    annotationClass - the annotation type
    
    Returns:
    
    the corresponding annotation bridge or null if there is no such annotation
    
    See Also:
    
    ArAnnotatedConstruct.getAnnotation(Class), ArAnnotationBridge.createBridge(ArAnnotation, Class)
  - isAnnotationPresent
```
public boolean isAnnotationPresent(ArClass annotationClass)
```
    Description copied from interface: ArAnnotatedConstruct
    
    Determines whether an annotation of the specified type exists on the object. This includes inherited annotations.
    
    Specified by:
    
    isAnnotationPresent in interface ArAnnotatedConstruct
    
    Parameters:
    
    annotationClass - the annotation type
    
    Returns:
    
    true if an annotation of the specified type is present on the object
  - isAnnotationPresent
```
public boolean isAnnotationPresent(Class<? extends Annotation> annotationClass)
```
    Description copied from interface: ArAnnotatedConstruct
    
    Determines whether an annotation of the specified type exists on the object. This includes inherited annotations.
    
    Specified by:
    
    isAnnotationPresent in interface ArAnnotatedConstruct
    
    Parameters:
    
    annotationClass - the annotation type
    
    Returns:
    
    true if an annotation of the specified type is present on the object
  - getDeclaredAnnotations
```
public List<ArAnnotation> getDeclaredAnnotations()
```
    Description copied from interface: ArAnnotatedConstruct
    
    Gets the annotations declared on this object.
    
    Specified by:
    
    getDeclaredAnnotations in interface ArAnnotatedConstruct
    
    Returns:
    
    the list of annotations

Class ArMethod

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.bluegosling.apt.reflect.ArMember

Methods inherited from interface com.bluegosling.apt.reflect.ArAnnotatedConstruct

Method Detail

forElement

getTypeParameters

getParameters

getReturnType

getGenericReturnType

getReceiverType

getDefaultValue

getParameterTypes

getGenericParameterTypes

isVarArgs

getParameterAnnotations

getExceptionTypes

getGenericExceptionTypes

equals

hashCode

toString

getDeclaringClass

getModifiers

getName

getAnnotations

asElement

getAnnotation

getAnnotation

getAnnotationBridge

isAnnotationPresent

isAnnotationPresent

getDeclaredAnnotations