AnnotatedTypeMirror.AnnotatedExecutableType

java.lang.Object
- org.checkerframework.framework.type.AnnotatedTypeMirror
- - org.checkerframework.framework.type.AnnotatedTypeMirror.AnnotatedExecutableType

Enclosing class:

AnnotatedTypeMirror
```
public static class AnnotatedTypeMirror.AnnotatedExecutableType
extends AnnotatedTypeMirror
```
Represents a type of an executable. An executable is a method, constructor, or initializer.

Nested Class Summary
- Nested classes/interfaces inherited from class org.checkerframework.framework.type.AnnotatedTypeMirror
  AnnotatedTypeMirror.AnnotatedArrayType, AnnotatedTypeMirror.AnnotatedDeclaredType, AnnotatedTypeMirror.AnnotatedExecutableType, AnnotatedTypeMirror.AnnotatedIntersectionType, AnnotatedTypeMirror.AnnotatedNoType, AnnotatedTypeMirror.AnnotatedNullType, AnnotatedTypeMirror.AnnotatedPrimitiveType, AnnotatedTypeMirror.AnnotatedTypeVariable, AnnotatedTypeMirror.AnnotatedUnionType, AnnotatedTypeMirror.AnnotatedWildcardType

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<AnnotatedTypeMirror>`	`paramTypes`
`protected AnnotatedTypeMirror.AnnotatedDeclaredType`	`receiverType`
`protected AnnotatedTypeMirror`	`returnType`
`protected List<AnnotatedTypeMirror>`	`throwsTypes`
`protected List<AnnotatedTypeMirror.AnnotatedTypeVariable>`	`typeVarTypes`

Fields inherited from class org.checkerframework.framework.type.AnnotatedTypeMirror
actualType, annotations, atypeFactory, equalityComparer, hashcodeVisitor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<R,P> R`	`accept(AnnotatedTypeVisitor<R,P> v, P p)` Applies a visitor to this type.
`void`	`addAnnotation(AnnotationMirror a)` It never makes sense to add annotations to an executable type - instead, they should be added to the right component.
`AnnotatedTypeMirror.AnnotatedExecutableType`	`deepCopy()`
`AnnotatedTypeMirror.AnnotatedExecutableType`	`deepCopy(boolean copyAnnotations)` Returns a deep copy of this type.
`@NonNull ExecutableElement`	`getElement()`
`AnnotatedTypeMirror.AnnotatedExecutableType`	`getErased()` Returns the erasure type of the this type, according to JLS specifications.
`List<AnnotatedTypeMirror>`	`getParameterTypes()`
`@Nullable AnnotatedTypeMirror.AnnotatedDeclaredType`	`getReceiverType()`
`AnnotatedTypeMirror`	`getReturnType()` The return type of a method or constructor.
`List<AnnotatedTypeMirror>`	`getThrownTypes()`
`List<AnnotatedTypeMirror.AnnotatedTypeVariable>`	`getTypeVariables()`
`ExecutableType`	`getUnderlyingType()` Returns the underlying unannotated Java type, which this wraps
`boolean`	`isVarArgs()`
`void`	`setElement(@NonNull ExecutableElement elem)`
`AnnotatedTypeMirror.AnnotatedExecutableType`	`shallowCopy()` Returns a shallow copy of this type with annotations.
`AnnotatedTypeMirror.AnnotatedExecutableType`	`shallowCopy(boolean copyAnnotations)` Returns a shallow copy of this type.

Methods inherited from class org.checkerframework.framework.type.AnnotatedTypeMirror
addAnnotation, addAnnotations, addMissingAnnotations, asUse, clearAnnotations, createType, createTypeOfObject, directSuperTypes, equals, getAnnotation, getAnnotationInHierarchy, getAnnotations, getAnnotationsField, getEffectiveAnnotation, getEffectiveAnnotationInHierarchy, getEffectiveAnnotations, getExplicitAnnotations, getKind, hasAnnotation, hasAnnotation, hasAnnotationRelaxed, hasEffectiveAnnotation, hasEffectiveAnnotation, hasEffectiveAnnotationRelaxed, hasExplicitAnnotation, hasExplicitAnnotation, hasExplicitAnnotationRelaxed, hashCode, isAnnotatedInHierarchy, isDeclaration, removeAnnotation, removeAnnotation, removeAnnotationInHierarchy, removeAnnotations, removeNonTopAnnotationInHierarchy, replaceAnnotation, replaceAnnotations, toString, toString

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

- Field Detail
  - paramTypes
```
protected final List<AnnotatedTypeMirror> paramTypes
```
  - receiverType
```
protected AnnotatedTypeMirror.AnnotatedDeclaredType receiverType
```
  - returnType
```
protected AnnotatedTypeMirror returnType
```
  - throwsTypes
```
protected final List<AnnotatedTypeMirror> throwsTypes
```
  - typeVarTypes
```
protected final List<AnnotatedTypeMirror.AnnotatedTypeVariable> typeVarTypes
```
- Method Detail
  - isVarArgs
```
public boolean isVarArgs()
```
    Returns:
    
    true if this type represents a varargs method
  - accept
```
public <R,P> R accept(AnnotatedTypeVisitor<R,P> v,
                      P p)
```
    Description copied from class: AnnotatedTypeMirror
    
    Applies a visitor to this type.
    
    Specified by:
    
    accept in class AnnotatedTypeMirror
    
    Type Parameters:
    
    R - the return type of the visitor's methods
    
    P - the type of the additional parameter to the visitor's methods
    
    Parameters:
    
    v - the visitor operating on this type
    
    p - additional parameter to the visitor
    
    Returns:
    
    a visitor-specified result
  - getUnderlyingType
```
public ExecutableType getUnderlyingType()
```
    Description copied from class: AnnotatedTypeMirror
    
    Returns the underlying unannotated Java type, which this wraps
    
    Overrides:
    
    getUnderlyingType in class AnnotatedTypeMirror
    
    Returns:
    
    the underlying type
  - addAnnotation
```
public void addAnnotation(AnnotationMirror a)
```
    It never makes sense to add annotations to an executable type - instead, they should be added to the right component.
    
    Overrides:
    
    addAnnotation in class AnnotatedTypeMirror
    
    Parameters:
    
    a - the annotation to add
  - getParameterTypes
```
public List<AnnotatedTypeMirror> getParameterTypes()
```
    Returns:
    
    the parameter types of this executable type
  - getReturnType
```
public AnnotatedTypeMirror getReturnType()
```
    The return type of a method or constructor. For constructors, the return type is not VOID, but the type of the enclosing class.
    
    Returns:
    
    the return type of this executable type
  - getReceiverType
```
public @Nullable AnnotatedTypeMirror.AnnotatedDeclaredType getReceiverType()
```
    Returns:
    
    the receiver type of this executable type; null for static methods and constructors of top-level classes
  - getThrownTypes
```
public List<AnnotatedTypeMirror> getThrownTypes()
```
    Returns:
    
    the thrown types of this executable type
  - getTypeVariables
```
public List<AnnotatedTypeMirror.AnnotatedTypeVariable> getTypeVariables()
```
    Returns:
    
    the type variables of this executable type, if any
  - deepCopy
```
public AnnotatedTypeMirror.AnnotatedExecutableType deepCopy(boolean copyAnnotations)
```
    Description copied from class: AnnotatedTypeMirror
    Returns a deep copy of this type. A deep copy implies that each component type is copied recursively and the returned type refers to those copies in its component locations.
    Note: deepCopy provides two important properties in the returned copy:
    1. Structure preservation -- The exact structure of the original AnnotatedTypeMirror is preserved in the copy including all component types.
    2. Annotation preservation -- All of the annotations from the original AnnotatedTypeMirror and its components have been copied to the new type.
    If copyAnnotations is set to false, the second property, Annotation preservation, is removed. This is useful for cases in which the user may want to copy the structure of a type exactly but NOT its annotations.
    Specified by:
    
    deepCopy in class AnnotatedTypeMirror
    
    Returns:
    
    a deep copy
  - deepCopy
```
public AnnotatedTypeMirror.AnnotatedExecutableType deepCopy()
```
    Specified by:
    
    deepCopy in class AnnotatedTypeMirror
    
    Returns:
    
    a deep copy of this type with annotations
    
    See Also:
    
    AnnotatedTypeMirror.deepCopy(boolean)
  - shallowCopy
```
public AnnotatedTypeMirror.AnnotatedExecutableType shallowCopy(boolean copyAnnotations)
```
    Description copied from class: AnnotatedTypeMirror
    
    Returns a shallow copy of this type. A shallow copy implies that each component type in the output copy refers to the same object as the object being copie.
    
    Specified by:
    
    shallowCopy in class AnnotatedTypeMirror
    
    Parameters:
    
    copyAnnotations - whether copy should have annotations, i.e. whether field annotations should be copied.
  - shallowCopy
```
public AnnotatedTypeMirror.AnnotatedExecutableType shallowCopy()
```
    Description copied from class: AnnotatedTypeMirror
    
    Returns a shallow copy of this type with annotations.
    
    Specified by:
    
    shallowCopy in class AnnotatedTypeMirror
    
    See Also:
    
    AnnotatedTypeMirror.shallowCopy(boolean)
  - getElement
```
public @NonNull ExecutableElement getElement()
```
  - setElement
```
public void setElement(@NonNull ExecutableElement elem)
```
  - getErased
```
public AnnotatedTypeMirror.AnnotatedExecutableType getErased()
```
    Description copied from class: AnnotatedTypeMirror
    
    Returns the erasure type of the this type, according to JLS specifications.
    
    Overrides:
    
    getErased in class AnnotatedTypeMirror
    
    Returns:
    
    the erasure of this AnnotatedTypeMirror, this is always a copy even if the erasure and the original type are equivalent
    
    See Also:
    
    https://docs.oracle.com/javase/specs/jls/se8/html/jls-4.html#jls-4.6

Class AnnotatedTypeMirror.AnnotatedExecutableType

Nested Class Summary

Nested classes/interfaces inherited from class org.checkerframework.framework.type.AnnotatedTypeMirror

Field Summary

Fields inherited from class org.checkerframework.framework.type.AnnotatedTypeMirror

Method Summary

Methods inherited from class org.checkerframework.framework.type.AnnotatedTypeMirror

Methods inherited from class java.lang.Object

Field Detail

paramTypes

receiverType

returnType

throwsTypes

typeVarTypes

Method Detail

isVarArgs

accept

getUnderlyingType

addAnnotation

getParameterTypes

getReturnType

getReceiverType

getThrownTypes

getTypeVariables

deepCopy

deepCopy

shallowCopy

shallowCopy

getElement

setElement

getErased