JavaxLangModelUtilities (repo.hcf.dev/javadoc/ball-api 20210415.0 API)

java.lang.Object
- ball.annotation.processing.JavaxLangModelUtilities

Direct Known Subclasses:

AbstractProcessor
```
public abstract class JavaxLangModelUtilities
extends Object
```
Utility methods for Processor and Taglet implementations.

Version:

$Revision: 7350 $

Author:

Allen D. Ball

Field Summary

Fields
Modifier and Type	Field and Description
`protected Elements`	`elements` See `ProcessingEnvironment.getElementUtils()`.
`protected JavaFileManager`	`fm` `JavacTask` `JavaFileManager` instance.
`static ball.annotation.processing.JavaxLangModelUtilities.ModifierMap`	`MODIFIERS`
`protected Types`	`types` See `ProcessingEnvironment.getTypeUtils()`.

Constructor Summary

Constructors
Constructor and Description

JavaxLangModelUtilities()

Constructors
Constructor and Description
`JavaxLangModelUtilities()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected Class<?>`	`asClass(TypeElement element)` Method to get the `Class` corresponding to a `TypeElement`.
`protected ExecutableElement`	`asExecutableElement(Constructor<?> constructor)` Method to get a `ExecutableElement` for a `Constructor`.
`protected ExecutableElement`	`asExecutableElement(Method method)` Method to get a `ExecutableElement` for a `Method`.
`protected Class<?>`	`asPackageInfoClass(PackageElement element)` Method to get the `package-info.class` (`Class`) corresponding to a `PackageElement`.
`protected TypeElement`	`asTypeElement(Class<?> type)` Method to get a `TypeElement` for a `Class`.
`protected TypeMirror`	`asTypeMirror(Class<?> type)` Method to get a `TypeMirror` for a `Class`.
`protected List<TypeMirror>`	`asTypeMirrorList(Class<?>... types)` Method to get a `List` of `TypeMirror`s for an array of `Class`es.
`protected VariableElement`	`asVariableElement(Field field)` Method to get a `VariableElement` for a `Field`.
`protected AnnotationMirror`	`getAnnotationMirror(Element element, Class<? extends Annotation> type)` Method to get an `Element`'s `AnnotationMirror`.
`protected AnnotationMirror`	`getAnnotationMirror(Element element, TypeElement type)` Method to get an `Element`'s `AnnotationMirror`.
`protected AnnotationValue`	`getAnnotationValue(AnnotationMirror annotation, String name)` Method to get an `AnnotationMirror` element's `AnnotationValue`.
`protected ClassLoader`	`getClassLoader()` Method to get the `ClassLoader` for loading dependencies.
`protected ClassLoader`	`getClassPathClassLoader(JavaFileManager fm)` See `JavaFileManager.getClassLoader(CLASS_PATH)`.
`protected ClassLoader`	`getClassPathClassLoader(JavaFileManager fm, ClassLoader parent)` See `JavaFileManager.getClassLoader(CLASS_PATH)`.
`protected ExecutableElement`	`getConstructor(TypeElement type, List<TypeMirror> parameters)` Constructor to get an `ExecutableElement` for a `Class` `Constructor` by parameter list.
`protected TypeElement`	`getEnclosingTypeElement(Element element)` Method to get the enclosing `TypeElement` for an `Element`.
`protected ExecutableElement`	`getMethod(Method method)` Deprecated.
`protected ExecutableElement`	`getMethod(TypeElement type, Method method)` Method to get an `ExecutableElement` for a `Method` prototype.
`protected String`	`getPropertyName(ExecutableElement element)` Method to get bean property name from an `ExecutableElement`.
`protected Set<String>`	`getPropertyNames(TypeElement type)` Method to get the `Set` of bean property names for the specified `TypeElement`.
`protected TypeElement`	`getTypeElementFor(Element context, String name)` Method to get the `TypeElement` for a context `Element`.
`protected Predicate<Element>`	`hasSameSignatureAs(CharSequence name, Class<?>[] parameters)`
`protected Predicate<Element>`	`hasSameSignatureAs(Executable executable)`
`protected Predicate<Element>`	`hasSameSignatureAs(List<TypeMirror> parameters)`
`protected ExecutableElement`	`implementationOf(ExecutableElement overridden, TypeElement type)` Method to return the `ExecutableElement` (`Method`) the argument `ExecutableElement` is overriden by (if any).
`protected Predicate<Element>`	`isAssignableTo(Class<?> type)`
`protected Predicate<Element>`	`isAssignableTo(Class<?> type, Function<? super Element,TypeMirror> extractor)`
`protected Predicate<Element>`	`isAssignableTo(TypeMirror type)`
`protected Predicate<Element>`	`isAssignableTo(TypeMirror type, Function<? super Element,TypeMirror> extractor)`
`protected boolean`	`isEmptyArray(AnnotationValue value)` Method to determine if an `AnnotationValue` is "empty": `null` or an empty array.
`protected boolean`	`isGetterMethod(ExecutableElement element)` Method to determine if an `ExecutableElement` is a bean getter.
`protected Predicate<Element>`	`named(CharSequence name)`
`protected ExecutableElement`	`overrides(ExecutableElement overrider)` Method to return the `ExecutableElement` (`Method`) the argument `ExecutableElement` overrides (if any).
`protected boolean`	`overrides(ExecutableElement overrider, ExecutableElement overridden)` Method to determine if a `ExecutableElement` (`Method`) overrides another `ExecutableElement`.
`protected String`	`signature(Executable executable)` Method to generate the application signature of an `Executable`.
`protected String`	`signature(ExecutableElement element)` Method to generate the application signature of an `ExecutableElement`.
`protected ExecutableElement`	`specifiedBy(ExecutableElement method)` Method to return the `ExecutableElement` (`Method`) the argument `ExecutableElement` is specified by (if any).
`protected <E extends Enum<E>> EnumSet<E>`	`toEnumSet(E[] array)`
`static int`	`toModifiers(Set<Modifier> set)` Method to get the `java.lang.reflect.Modifier` flags for a `Set` of `Modifier`s.
`protected <E> Predicate<Element>`	`with(Set<E> set, Function<Element,Collection<E>> extractor)`
`protected Predicate<Element>`	`withModifiers(Modifier... modifiers)`
`protected Predicate<Element>`	`withModifiers(Set<Modifier> modifiers)`
`protected <E> Predicate<Element>`	`without(Set<E> set, Function<Element,Collection<E>> extractor)`
`protected Predicate<Element>`	`withoutModifiers(Modifier... modifiers)`
`protected Predicate<Element>`	`withoutModifiers(Set<Modifier> modifiers)`
`protected Predicate<Element>`	`withParameters(Class<?>[] parameters)`
`protected Predicate<Element>`	`withParameters(List<TypeMirror> parameters)`

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

- Field Detail
  - MODIFIERS
```
public static final ball.annotation.processing.JavaxLangModelUtilities.ModifierMap MODIFIERS
```
  - elements
```
protected Elements elements
```
    See ProcessingEnvironment.getElementUtils().
  - types
```
protected Types types
```
    See ProcessingEnvironment.getTypeUtils().
  - fm
```
protected JavaFileManager fm
```
    JavacTask JavaFileManager instance.
- Constructor Detail
  - JavaxLangModelUtilities
```
public JavaxLangModelUtilities()
```
- Method Detail
  - getClassLoader
```
protected ClassLoader getClassLoader()
```
    Method to get the ClassLoader for loading dependencies.
    
    Returns:
    
    The ClassLoader.
  - asClass
```
protected Class<?> asClass(TypeElement element)
```
    Method to get the Class corresponding to a TypeElement.
    
    Parameters:
    
    element - The TypeElement.
    
    Returns:
    
    The Class for the TypeElement.
  - asPackageInfoClass
```
protected Class<?> asPackageInfoClass(PackageElement element)
```
    Method to get the package-info.class (Class) corresponding to a PackageElement.
    
    Parameters:
    
    element - The PackageElement.
    
    Returns:
    
    The Class for the PackageElement package-info.class.
  - asTypeElement
```
protected TypeElement asTypeElement(Class<?> type)
```
    Method to get a TypeElement for a Class.
    
    Parameters:
    
    type - The Class.
    
    Returns:
    
    The TypeElement for the Class.
  - asExecutableElement
```
protected ExecutableElement asExecutableElement(Constructor<?> constructor)
```
    Method to get a ExecutableElement for a Constructor.
    
    Parameters:
    
    constructor - The Constructor.
    
    Returns:
    
    The ExecutableElement for the Constructor.
  - asExecutableElement
```
protected ExecutableElement asExecutableElement(Method method)
```
    Method to get a ExecutableElement for a Method.
    
    Parameters:
    
    method - The Method.
    
    Returns:
    
    The ExecutableElement for the Method.
  - getMethod
```
@Deprecated
protected ExecutableElement getMethod(Method method)
```
    Deprecated.
  - asVariableElement
```
protected VariableElement asVariableElement(Field field)
```
    Method to get a VariableElement for a Field.
    
    Parameters:
    
    field - The Field.
    
    Returns:
    
    The VariableElement for the Field.
  - asTypeMirror
```
protected TypeMirror asTypeMirror(Class<?> type)
```
    Method to get a TypeMirror for a Class.
    
    Parameters:
    
    type - The Class.
    
    Returns:
    
    The TypeMirror for the Class.
  - asTypeMirrorList
```
protected List<TypeMirror> asTypeMirrorList(Class<?>... types)
```
    Method to get a List of TypeMirrors for an array of Classes.
    
    Parameters:
    
    types - The array of Classes.
    
    Returns:
    
    The List of TypeMirrors.
  - getEnclosingTypeElement
```
protected TypeElement getEnclosingTypeElement(Element element)
```
    Method to get the enclosing TypeElement for an Element.
    
    Parameters:
    
    element - The Element.
    
    Returns:
    
    The enclosing TypeElement.
  - getTypeElementFor
```
protected TypeElement getTypeElementFor(Element context,
                                        String name)
```
    Method to get the TypeElement for a context Element.
    
    Parameters:
    
    context - The context Element.
    
    name - The name of the Element (Class).
    
    Returns:
    
    The context's TypeElement.
  - getConstructor
```
protected ExecutableElement getConstructor(TypeElement type,
                                           List<TypeMirror> parameters)
```
    Constructor to get an ExecutableElement for a Class Constructor by parameter list.
    
    Parameters:
    
    type - The TypeElement.
    
    parameters - The constructor parameter types.
    
    Returns:
    
    The ExecutableElement for the constructor.
  - getMethod
```
protected ExecutableElement getMethod(TypeElement type,
                                      Method method)
```
    Method to get an ExecutableElement for a Method prototype.
    
    Parameters:
    
    type - The TypeElement.
    
    method - The prototype Method.
    
    Returns:
    
    The ExecutableElement for the method.
  - overrides
```
protected ExecutableElement overrides(ExecutableElement overrider)
```
    Method to return the ExecutableElement (Method) the argument ExecutableElement overrides (if any).
    
    Parameters:
    
    overrider - The ExecutableElement.
    
    Returns:
    
    The overridden ExecutableElement if any; null otherwise.
    
    See Also:
    
    Elements.overrides(ExecutableElement,ExecutableElement,TypeElement)
  - overrides
```
protected boolean overrides(ExecutableElement overrider,
                            ExecutableElement overridden)
```
    Method to determine if a ExecutableElement (Method) overrides another ExecutableElement.
    
    Parameters:
    
    overrider - The (possibly) overriding ExecutableElement.
    
    overridden - The overridden ExecutableElement.
    
    Returns:
    
    true if overrider overrides overridden; false otherwise.
    
    See Also:
    
    Elements.overrides(ExecutableElement,ExecutableElement,TypeElement)
  - implementationOf
```
protected ExecutableElement implementationOf(ExecutableElement overridden,
                                             TypeElement type)
```
    Method to return the ExecutableElement (Method) the argument ExecutableElement is overriden by (if any).
    
    Parameters:
    
    overridden - The ExecutableElement.
    
    type - The TypeElement.
    
    Returns:
    
    The overriding ExecutableElement if any; null otherwise.
    
    See Also:
    
    overrides(ExecutableElement)
  - specifiedBy
```
protected ExecutableElement specifiedBy(ExecutableElement method)
```
    Method to return the ExecutableElement (Method) the argument ExecutableElement is specified by (if any).
    
    Parameters:
    
    method - The ExecutableElement.
    
    Returns:
    
    The specification ExecutableElement if any; null otherwise.
    
    See Also:
    
    overrides(ExecutableElement)
  - signature
```
protected String signature(Executable executable)
```
    Method to generate the application signature of an Executable.
    
    Parameters:
    
    executable - The Executable.
    
    Returns:
    
    The signature String.
  - signature
```
protected String signature(ExecutableElement element)
```
    Method to generate the application signature of an ExecutableElement.
    
    Parameters:
    
    element - The ExecutableElement.
    
    Returns:
    
    The signature String.
  - getAnnotationMirror
```
protected AnnotationMirror getAnnotationMirror(Element element,
                                               Class<? extends Annotation> type)
```
    Method to get an Element's AnnotationMirror.
    
    Parameters:
    
    element - The annotated Element.
    
    type - The Annotation type (Class).
    
    Returns:
    
    The AnnotationMirror if the Element is annotated with the argument annotation; null otherwise.
    
    See Also:
    
    Element.getAnnotationMirrors()
  - getAnnotationMirror
```
protected AnnotationMirror getAnnotationMirror(Element element,
                                               TypeElement type)
```
    Method to get an Element's AnnotationMirror.
    
    Parameters:
    
    element - The annotated Element.
    
    type - The Annotation type (TypeElement).
    
    Returns:
    
    The AnnotationMirror if the Element is annotated with the argument annotation; null otherwise.
    
    See Also:
    
    Element.getAnnotationMirrors()
  - getAnnotationValue
```
protected AnnotationValue getAnnotationValue(AnnotationMirror annotation,
                                             String name)
```
    Method to get an AnnotationMirror element's AnnotationValue.
    
    Parameters:
    
    annotation - The AnnotationMirror.
    
    name - The simple name of the element.
    
    Returns:
    
    The AnnotationValue if it is defined; null otherwise.
    
    See Also:
    
    Elements.getElementValuesWithDefaults(AnnotationMirror)
  - isEmptyArray
```
protected boolean isEmptyArray(AnnotationValue value)
```
    Method to determine if an AnnotationValue is "empty": null or an empty array.
    
    Parameters:
    
    value - The AnnotationValue.
    
    Returns:
    
    true if empty; {code false} otherwise.
  - getPropertyName
```
protected String getPropertyName(ExecutableElement element)
```
    Method to get bean property name from an ExecutableElement.
    
    Parameters:
    
    element - The ExecutableElement.
    
    Returns:
    
    the name String if the ExecutableElement is a getter or setter method; null otherwise.
  - isGetterMethod
```
protected boolean isGetterMethod(ExecutableElement element)
```
    Method to determine if an ExecutableElement is a bean getter.
    
    Parameters:
    
    element - The ExecutableElement.
    
    Returns:
    
    true if the Element has a non-private getter method; false otherwise.
  - getPropertyNames
```
protected Set<String> getPropertyNames(TypeElement type)
```
    Method to get the Set of bean property names for the specified TypeElement.
    
    Parameters:
    
    type - The TypeElement to analyze.
    
    Returns:
    
    The Set of bean property names.
  - toEnumSet
```
protected <E extends Enum<E>> EnumSet<E> toEnumSet(E[] array)
```
  - hasSameSignatureAs
```
protected Predicate<Element> hasSameSignatureAs(List<TypeMirror> parameters)
```
  - hasSameSignatureAs
```
protected Predicate<Element> hasSameSignatureAs(Executable executable)
```
  - hasSameSignatureAs
```
protected Predicate<Element> hasSameSignatureAs(CharSequence name,
                                                Class<?>[] parameters)
```
  - isAssignableTo
```
protected Predicate<Element> isAssignableTo(Class<?> type)
```
  - isAssignableTo
```
protected Predicate<Element> isAssignableTo(TypeMirror type)
```
  - isAssignableTo
```
protected Predicate<Element> isAssignableTo(Class<?> type,
                                            Function<? super Element,TypeMirror> extractor)
```
  - isAssignableTo
```
protected Predicate<Element> isAssignableTo(TypeMirror type,
                                            Function<? super Element,TypeMirror> extractor)
```
  - named
```
protected Predicate<Element> named(CharSequence name)
```
  - withParameters
```
protected Predicate<Element> withParameters(Class<?>[] parameters)
```
  - withParameters
```
protected Predicate<Element> withParameters(List<TypeMirror> parameters)
```
  - withModifiers
```
protected Predicate<Element> withModifiers(Modifier... modifiers)
```
  - withModifiers
```
protected Predicate<Element> withModifiers(Set<Modifier> modifiers)
```
  - withoutModifiers
```
protected Predicate<Element> withoutModifiers(Modifier... modifiers)
```
  - withoutModifiers
```
protected Predicate<Element> withoutModifiers(Set<Modifier> modifiers)
```
  - with
```
protected <E> Predicate<Element> with(Set<E> set,
                                      Function<Element,Collection<E>> extractor)
```
  - without
```
protected <E> Predicate<Element> without(Set<E> set,
                                         Function<Element,Collection<E>> extractor)
```
  - getClassPathClassLoader
```
protected ClassLoader getClassPathClassLoader(JavaFileManager fm,
                                              ClassLoader parent)
```
    See JavaFileManager.getClassLoader(CLASS_PATH).
    
    Parameters:
    
    fm - The JavaFileManager.
    
    parent - The parent ClassLoader.
    
    Returns:
    
    The ClassLoader.
  - getClassPathClassLoader
```
protected ClassLoader getClassPathClassLoader(JavaFileManager fm)
```
    See JavaFileManager.getClassLoader(CLASS_PATH).
    
    Parameters:
    
    fm - The JavaFileManager.
    
    Returns:
    
    The ClassLoader.
  - toModifiers
```
public static int toModifiers(Set<Modifier> set)
```
    Method to get the java.lang.reflect.Modifier flags for a Set of Modifiers.
    
    Parameters:
    
    set - The Modifiers.
    
    Returns:
    
    The flags.

Class JavaxLangModelUtilities

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MODIFIERS

elements

types

fm

Constructor Detail

JavaxLangModelUtilities

Method Detail

getClassLoader

asClass

asPackageInfoClass

asTypeElement

asExecutableElement

asExecutableElement

getMethod

asVariableElement

asTypeMirror

asTypeMirrorList

getEnclosingTypeElement

getTypeElementFor

getConstructor

getMethod

overrides

overrides

implementationOf

specifiedBy

signature

signature

getAnnotationMirror

getAnnotationMirror

getAnnotationValue

isEmptyArray

getPropertyName

isGetterMethod

getPropertyNames

toEnumSet

hasSameSignatureAs

hasSameSignatureAs

hasSameSignatureAs

isAssignableTo

isAssignableTo

isAssignableTo

isAssignableTo

named

withParameters

withParameters

withModifiers

withModifiers

withoutModifiers

withoutModifiers

with

without

getClassPathClassLoader

getClassPathClassLoader

toModifiers