ElementUtils

@NonNull java.lang.Object
- checkers.util.ElementUtils

public class ElementUtils
extends @NonNull Object

A Utility class for analyzing Elements

Method Summary

Methods
Modifier and Type	Method and Description
`static TypeElement`	`enclosingClass(@Nullable Element elem)` Returns the innermost type element enclosing the given element
`static PackageElement`	`enclosingPackage(@Nullable Element elem)` Returns the innermost package element enclosing the given element.
`static VariableElement`	`findFieldInType(TypeElement type, @ReadOnly String name)` Returns the field of the class
`static Set<VariableElement>`	`findFieldsInType(TypeElement type, Collection<@ReadOnly String> names)`
`static @Nullable Name`	`getQualifiedClassName(@Nullable Element element)` Returns the qualified name of the inner most class enclosing the provided `Element`
`static Set<TypeElement>`	`getSuperTypes(TypeElement type)` Determine all type elements for the classes and interfaces referenced in the extends/implements clauses of the given type element.
`static TypeMirror`	`getType(@Nullable Element element)` Returns the `TypeMirror` for usage of Element as a value.
`static @ReadOnly String`	`getVerboseName(@Nullable Element elt)` Returns a verbose name that identifies the element.
`static boolean`	`hasReceiver(@Nullable Element element)` Does the given element need a receiver for accesses? For example, an access to a local variable does not require a receiver.
`static boolean`	`isCompileTimeConstant(@Nullable Element elt)` Returns true if the element is a constant time reference
`static boolean`	`isError(@Nullable Element element)`
`static boolean`	`isFinal(@Nullable Element element)` Returns true if the element is a final element: a final field, final method, or final class
`static boolean`	`isObject(TypeElement element)` Check if the element is an element for 'java.lang.Object'
`static boolean`	`isStatic(@Nullable Element element)` Returns true if the element is a static element: whether it is a static field, static method, or static class

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

- Method Detail
  - enclosingClass
```
public static TypeElement enclosingClass(@Nullable Element elem)
```
    Returns the innermost type element enclosing the given element
    
    Parameters:
    elem - the enclosed element of a class
    
    Returns:
    the innermost type element
  - enclosingPackage
```
public static PackageElement enclosingPackage(@Nullable Element elem)
```
    Returns the innermost package element enclosing the given element. The same effect as Elements.getPackageOf(Element).
    
    Parameters:
    elem - the enclosed element of a package
    
    Returns:
    the innermost package element
  - isStatic
```
public static boolean isStatic(@Nullable Element element)
```
    Returns true if the element is a static element: whether it is a static field, static method, or static class
    
    Parameters:
    element -
    
    Returns:
    true if element is static
  - isFinal
```
public static boolean isFinal(@Nullable Element element)
```
    Returns true if the element is a final element: a final field, final method, or final class
    
    Parameters:
    element -
    
    Returns:
    true if the element is final
  - getType
```
public static TypeMirror getType(@Nullable Element element)
```
    Returns the TypeMirror for usage of Element as a value. It returns the return type of a method element, the class type of a constructor, or simply the type mirror of the element itself.
    
    Parameters:
    element -
    
    Returns:
    the type for the element used as a value
  - getQualifiedClassName
```
public static @Nullable Name getQualifiedClassName(@Nullable Element element)
```
    Returns the qualified name of the inner most class enclosing the provided Element
    
    Parameters:
    element - an element enclosed by a class, or a TypeElement
    
    Returns:
    The qualified Name of the innermost class enclosing the element
  - getVerboseName
```
public static @ReadOnly String getVerboseName(@Nullable Element elt)
```
    Returns a verbose name that identifies the element.
  - isObject
```
public static boolean isObject(TypeElement element)
```
    Check if the element is an element for 'java.lang.Object'
    
    Parameters:
    element - the type element
    
    Returns:
    true iff the element is java.lang.Object element
  - isCompileTimeConstant
```
public static boolean isCompileTimeConstant(@Nullable Element elt)
```
    Returns true if the element is a constant time reference
  - findFieldInType
```
public static VariableElement findFieldInType(TypeElement type,
                              @ReadOnly String name)
```
    Returns the field of the class
  - findFieldsInType
```
public static Set<VariableElement> findFieldsInType(TypeElement type,
                                    Collection<@ReadOnly String> names)
```
  - isError
```
public static boolean isError(@Nullable Element element)
```
  - hasReceiver
```
public static boolean hasReceiver(@Nullable Element element)
```
    Does the given element need a receiver for accesses? For example, an access to a local variable does not require a receiver.
    
    Parameters:
    element - The element to test.
    
    Returns:
    whether the element requires a receiver for accesses.
  - getSuperTypes
```
public static Set<TypeElement> getSuperTypes(TypeElement type)
```
    Determine all type elements for the classes and interfaces referenced in the extends/implements clauses of the given type element.

Class ElementUtils

Method Summary

Methods inherited from class java.lang.Object

Method Detail

enclosingClass

enclosingPackage

isStatic

isFinal

getType

getQualifiedClassName

getVerboseName

isObject

isCompileTimeConstant

findFieldInType

findFieldsInType

isError

hasReceiver

getSuperTypes