ElementUtilities (Java Source Base)

java.lang.Object
- org.netbeans.api.java.source.ElementUtilities

public final class ElementUtilities
extends Object

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ElementUtilities.ElementAcceptor
Filter Elements

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ElementUtilities.ElementAcceptor` Filter `Element`s

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`alreadyDefinedIn(CharSequence name, ExecutableType method, TypeElement enclClass)` Returns true if a method specified by name and type is defined in a class type.
`TypeElement`	`enclosingTypeElement(Element element)` Returns the type element within which this member or constructor is declared.
`Element`	`findElement(String description)` Looks up the given Java element.
`Map<? extends Element,Scope>`	`findElementsAndOrigins(Scope scope, ElementUtilities.ElementAcceptor acceptor)` Finds symbols which satisfy the acceptor visible in the passed scope.
`List<? extends ExecutableElement>`	`findOverridableMethods(TypeElement type)` Find all methods in given type and its supertypes, which are overridable.
`List<? extends ExecutableElement>`	`findUnimplementedMethods(TypeElement impl)` Find all methods in given type and its supertypes, which are not implemented.
`List<? extends ExecutableElement>`	`findUnimplementedMethods(TypeElement impl, boolean includeDefaults)` Finds all unimplemented methods in the given type and supertypes, but possibly include also interface default methods.
`static String`	`getBinaryName(TypeElement element)` Returns a binary name of a type.
`ExecutableElement`	`getDescriptorElement(TypeElement origin)` Find the element of the method descriptor associated to the functional interface.
`CharSequence`	`getElementName(Element el, boolean fqn)` Returns name of the given element.
`Iterable<? extends TypeElement>`	`getGlobalTypes(ElementUtilities.ElementAcceptor acceptor)` Return `TypeElement`s: which are imported which are in the same package as the current file which are in the java.lang package
`Element`	`getImplementationOf(ExecutableElement method, TypeElement origin)` Returns the implementation of a method in class origin; null if none exists.
`Iterable<? extends Element>`	`getLocalMembersAndVars(Scope scope, ElementUtilities.ElementAcceptor acceptor)` Return members declared in the given scope.
`Iterable<? extends Element>`	`getLocalVars(Scope scope, ElementUtilities.ElementAcceptor acceptor)` Return variables declared in the given scope.
`Iterable<? extends Element>`	`getMembers(TypeMirror type, ElementUtilities.ElementAcceptor acceptor)` Returns all members of a type, whether inherited or declared directly.
`ExecutableElement`	`getOverriddenMethod(ExecutableElement method)` Returns the parent method which the specified method overrides, or null if the method does not override a parent class method.
`boolean`	`hasGetter(TypeElement type, VariableElement field, CodeStyle codeStyle)` Check whether given type has a getter method for the given field.
`boolean`	`hasSetter(TypeElement type, VariableElement field, CodeStyle codeStyle)` Check whether given type has a setter method for the given field.
`boolean`	`implementsMethod(ExecutableElement element)` Returns true if this element represents a method which implements a method in an interface the parent class implements.
`boolean`	`isEffectivelyFinal(VariableElement e)` Check whether the given variable is effectively final or final.
`boolean`	`isErroneous(Element e)` Checks whether 'e' contains error or is missing.
`boolean`	`isLocal(Element element)` Returns true if the element is declared (directly or indirectly) local to a method or variable initializer.
`boolean`	`isMemberOf(Element e, TypeElement type)` Returns true if a type element has the specified element as a member.
`boolean`	`isOpen(ModuleElement element)` Returns true if the given module is open.
`boolean`	`isSynthetic(Element element)` Returns true if the given element is synthetic.
`TypeElement`	`outermostTypeElement(Element element)` The outermost TypeElement which indirectly encloses this element.
`boolean`	`overridesMethod(ExecutableElement element)` Returns true if this element represents a method which overrides a method in one of its superclasses.

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

- Method Detail
  - enclosingTypeElement
```
public TypeElement enclosingTypeElement(Element element)
                                 throws IllegalArgumentException
```
    Returns the type element within which this member or constructor is declared. Does not accept packages If this is the declaration of a top-level type (a non-nested class or interface), returns null.
    
    Returns:
    
    the type declaration within which this member or constructor is declared, or null if there is none
    
    Throws:
    
    IllegalArgumentException - if the provided element is a package element
  - outermostTypeElement
```
public TypeElement outermostTypeElement(Element element)
```
    The outermost TypeElement which indirectly encloses this element.
  - getImplementationOf
```
public Element getImplementationOf(ExecutableElement method,
                                   TypeElement origin)
```
    Returns the implementation of a method in class origin; null if none exists.
  - isSynthetic
```
public boolean isSynthetic(Element element)
```
    Returns true if the given element is synthetic.
    
    Parameters:
    
    element - to check
    
    Returns:
    
    true if and only if the given element is synthetic, false otherwise
  - isOpen
```
public boolean isOpen(ModuleElement element)
```
    Returns true if the given module is open.
    
    Parameters:
    
    element - to check
    
    Returns:
    
    true if and only if the given module is open, false otherwise
  - overridesMethod
```
public boolean overridesMethod(ExecutableElement element)
```
    Returns true if this element represents a method which overrides a method in one of its superclasses.
  - getBinaryName
```
public static String getBinaryName(TypeElement element)
                            throws IllegalArgumentException
```
    Returns a binary name of a type.
    
    Parameters:
    
    element - for which the binary name should be returned
    
    Returns:
    
    the binary name, see Java Language Specification 13.1
    
    Throws:
    
    IllegalArgumentException - when the element is not a javac element
  - getMembers
```
public Iterable<? extends Element> getMembers(TypeMirror type,
                                              ElementUtilities.ElementAcceptor acceptor)
```
    Returns all members of a type, whether inherited or declared directly. For a class the result also includes its constructors, but not local or anonymous classes.
    
    Parameters:
    
    type - the type being examined
    
    acceptor - to filter the members
    
    Returns:
    
    all members in the type
    
    See Also:
    
    Elements.getAllMembers(javax.lang.model.element.TypeElement)
  - findElementsAndOrigins
```
@NonNull
public Map<? extends Element,Scope> findElementsAndOrigins(@NonNull
                                                                    Scope scope,
                                                                    ElementUtilities.ElementAcceptor acceptor)
```
    Finds symbols which satisfy the acceptor visible in the passed scope. The method returns a Map keyed by the found Elements. Each Element is mapped to the closest Scope which introduced the Element. For example, a field declared by an outer class will map to that outer class' scope. An accessible field inherited from outer class' superclass will also map to the outer class' scope. The caller can then determine, based on Element.getEnclosingElement() and the mapped Scope whether the symbol is directly declared, or inherited. Non-member symbols (variables, parameters, try resources, ...) map to Scope of their defining Method.
    If an Element from outer Scope is hidden by a similar Element in inner scope, only the Element visible to the passed Scope is returned. For example, if both the starting (inner) class and its outer class define method m(), only InnerClass.m() will be returned.
    Note that Scope.getEnclosingMethod() returns non-null even for class scopes of local or anonymous classes; check both Scope.getEnclosingClass() and Scope.getEnclosingMethod() and their relationship to get the appropriate Element associated with the Scope.
    
    Parameters:
    
    scope - the initial search scope
    
    acceptor - the element filter.
    
    Returns:
    
    Mapping of visible and accessible Elements to their defining Scopes (which introduced them).
    
    Since:
    
    2.16
    
    See Also:
    
    Scope
  - getLocalMembersAndVars
```
public Iterable<? extends Element> getLocalMembersAndVars(Scope scope,
                                                          ElementUtilities.ElementAcceptor acceptor)
```
    Return members declared in the given scope.
  - getLocalVars
```
public Iterable<? extends Element> getLocalVars(Scope scope,
                                                ElementUtilities.ElementAcceptor acceptor)
```
    Return variables declared in the given scope.
  - getGlobalTypes
```
public Iterable<? extends TypeElement> getGlobalTypes(ElementUtilities.ElementAcceptor acceptor)
```
    Return TypeElements:
    - which are imported
    - which are in the same package as the current file
    - which are in the java.lang package
  - getElementName
```
public CharSequence getElementName(Element el,
                                   boolean fqn)
```
    Returns name of the given element.
    
    Parameters:
    
    el - element
    
    fqn - true if fully qualified name should be returned
    
    Returns:
    
    requested name
    
    Since:
    
    0.136
  - isLocal
```
public boolean isLocal(Element element)
```
    Returns true if the element is declared (directly or indirectly) local to a method or variable initializer. Also true for fields of inner classes which are in turn local to a method or variable initializer.
  - alreadyDefinedIn
```
public boolean alreadyDefinedIn(CharSequence name,
                                ExecutableType method,
                                TypeElement enclClass)
```
    Returns true if a method specified by name and type is defined in a class type.
  - isMemberOf
```
public boolean isMemberOf(Element e,
                          TypeElement type)
```
    Returns true if a type element has the specified element as a member.
  - getOverriddenMethod
```
public ExecutableElement getOverriddenMethod(ExecutableElement method)
```
    Returns the parent method which the specified method overrides, or null if the method does not override a parent class method.
  - implementsMethod
```
public boolean implementsMethod(ExecutableElement element)
```
    Returns true if this element represents a method which implements a method in an interface the parent class implements.
  - findUnimplementedMethods
```
public List<? extends ExecutableElement> findUnimplementedMethods(TypeElement impl)
```
    Find all methods in given type and its supertypes, which are not implemented. Will not return default methods implemented directly in interfaces in impl type closure.
    
    Parameters:
    
    impl - to inspect
    
    Returns:
    
    list of all unimplemented methods
    
    Since:
    
    0.20, 2.15 does not return default methods
  - findUnimplementedMethods
```
public List<? extends ExecutableElement> findUnimplementedMethods(TypeElement impl,
                                                                  boolean includeDefaults)
```
    Finds all unimplemented methods in the given type and supertypes, but possibly include also interface default methods.
    If the platform configured for the type is older than JDK8, the method is equivalent to ElementUtilities.findUnimplementedMethods(javax.lang.model.element.TypeElement). If `includeDefaults' is true, returns also default methods as if the methods were required to be reimplemented by the final class.
    
    Parameters:
    
    impl - the implementation type
    
    includeDefaults - if true, will also return interface default methods, which are not overriden in supertypes
    
    Returns:
    
    unimplemented (and/or default) methods.
    
    Since:
    
    2.15
  - findOverridableMethods
```
public List<? extends ExecutableElement> findOverridableMethods(TypeElement type)
```
    Find all methods in given type and its supertypes, which are overridable.
    
    Parameters:
    
    type - to inspect
    
    Returns:
    
    list of all overridable methods
    
    Since:
    
    0.136
  - hasGetter
```
public boolean hasGetter(TypeElement type,
                         VariableElement field,
                         CodeStyle codeStyle)
```
    Check whether given type has a getter method for the given field.
    
    Parameters:
    
    type - to inspect
    
    field - to search getter for
    
    codeStyle -
    
    Returns:
    
    true if getter method exists
    
    Since:
    
    0.136
  - hasSetter
```
public boolean hasSetter(TypeElement type,
                         VariableElement field,
                         CodeStyle codeStyle)
```
    Check whether given type has a setter method for the given field.
    
    Parameters:
    
    type - to inspect
    
    field - to search setter for
    
    codeStyle -
    
    Returns:
    
    true if setter method exists
    
    Since:
    
    0.136
  - isErroneous
```
public boolean isErroneous(@NullAllowed
                           Element e)
```
    Checks whether 'e' contains error or is missing. If the passed element is null it's assumed the element could not be resolved and this method returns true. Otherwise, the element's type kind is checked against error constants and finally the erroneous state of the element is checked.
    
    Parameters:
    
    e - Element to check or null
    
    Returns:
    
    true, if the element is missing (is null) or contains errors.
  - isEffectivelyFinal
```
public boolean isEffectivelyFinal(VariableElement e)
```
    Check whether the given variable is effectively final or final.
    
    Parameters:
    
    e - variable to check for effectively final status
    
    Returns:
    
    true if the given variable is effectively final or final
    
    Since:
    
    0.112
  - findElement
```
@CheckForNull
public Element findElement(@NonNull
                                         String description)
```
    Looks up the given Java element. The elementDescription format is as follows:
    
    for type (class, enum, interface or annotation type)
    
    the FQN of the type
    
    for field or enum constant
    
    the FQN of the enclosing type.field name
    
    for method
    
    the FQN of the enclosing type.method name(comma separated parameter types)
    The parameter types may include type parameters, but these are ignored. The last parameter type can use ellipsis (...) to denote vararg method.
    
    for constructor
    
    the FQN of the enclosing type.simple name of enclosing type(comma separated parameter types)
    See method format for more details on parameter types.
    
    Parameters:
    
    description - the description of the element that should be checked for existence
    
    Returns:
    
    the found element, or null if not available
    
    Since:
    
    0.115
  - getDescriptorElement
```
public ExecutableElement getDescriptorElement(TypeElement origin)
```
    Find the element of the method descriptor associated to the functional interface.
    
    Parameters:
    
    origin - functional interface element
    
    Returns:
    
    associated method descriptor element or null if the origin is not a functional interface.
    
    Since:
    
    2.14

Class ElementUtilities

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

enclosingTypeElement

outermostTypeElement

getImplementationOf

isSynthetic

isOpen

overridesMethod

getBinaryName

getMembers

findElementsAndOrigins

getLocalMembersAndVars

getLocalVars

getGlobalTypes

getElementName

isLocal

alreadyDefinedIn

isMemberOf

getOverriddenMethod

implementsMethod

findUnimplementedMethods

findUnimplementedMethods

findOverridableMethods

hasGetter

hasSetter

isErroneous

isEffectivelyFinal

findElement

getDescriptorElement