Package com.oracle.truffle.libgraal.processor

Class BaseProcessor

java.lang.Object

javax.annotation.processing.AbstractProcessor

com.oracle.truffle.libgraal.processor.BaseProcessor

All Implemented Interfaces:

Processor

Direct Known Subclasses:

TruffleFromLibGraalProcessor

public abstract class BaseProcessor
extends AbstractProcessor

AbstractProcessor subclass that provides extra functionality.

Field Summary

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor	Description
BaseProcessor()

Method Summary

Modifier and Type	Method	Description
TypeElement	asTypeElement(TypeMirror type)	Converts a given TypeMirror to a TypeElement.
void	createProviderFile(String providerClassName, String serviceClassName, Element... originatingElements)	Creates a META-INF/providers/<providerClassName> file whose contents are a single line containing serviceClassName.
static PrintWriter	createSourceFile(String pkg, String relativeName, Filer filer, Element... originatingElements)
protected abstract boolean	doProcess(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv)
ProcessingEnvironment	env()	Gets the processing environment available to this processor.
AnnotationMirror	getAnnotation(Element element, TypeMirror annotationType)	Gets the annotation of type annotationType directly present on element.
List<AnnotationMirror>	getAnnotations(Element element, TypeMirror typeMirror)	Gets all annotations directly present on element.
static <T> T	getAnnotationValue(AnnotationMirror annotation, String name, Class<T> type)	Gets the value of the name element of annotation and converts it to a value of type type.
static <T> List<T>	getAnnotationValueList(AnnotationMirror annotation, String name, Class<T> componentType)	Gets the value of the name array-typed element of annotation and converts it to list of values of type type.
static PackageElement	getPackage(Element element)
static String	getPackageName(String className)	Gets the package component of a qualified class name.
static String	getSimpleName(String className)	Gets the non-package component of a qualified class name.
final SourceVersion	getSupportedSourceVersion()
TypeMirror	getType(Class<?> element)
TypeMirror	getType(String className)	Gets the TypeMirror for a given class name.
TypeElement	getTypeElement(String className)	Gets the TypeElement for a given class name.
TypeElement	getTypeElementOrNull(String className)	Gets the TypeElement for a given class name.
TypeMirror	getTypeOrNull(String className)	Gets the TypeMirror for a given class name.
boolean	process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv)

Methods inherited from class javax.annotation.processing.AbstractProcessor

getCompletions, getSupportedAnnotationTypes, getSupportedOptions, init, isInitialized

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BaseProcessor

public BaseProcessor()

Method Details

env

public ProcessingEnvironment env()

Gets the processing environment available to this processor.

getSupportedSourceVersion

public final SourceVersion getSupportedSourceVersion()

Specified by:

getSupportedSourceVersion in interface Processor

Overrides:

getSupportedSourceVersion in class AbstractProcessor

process

public boolean process(Set<? extends TypeElement> annotations,
 RoundEnvironment roundEnv)

Specified by:

process in interface Processor

Specified by:

process in class AbstractProcessor

doProcess

protected abstract boolean doProcess(Set<? extends TypeElement> annotations,
 RoundEnvironment roundEnv)

getType

public TypeMirror getType(String className)

Gets the TypeMirror for a given class name.

Throws:

NoClassDefFoundError - if the class cannot be resolved

getType

public TypeMirror getType(Class<?> element)

getTypeOrNull

public TypeMirror getTypeOrNull(String className)

Gets the TypeMirror for a given class name.

Returns:

null if the class cannot be resolved

getTypeElement

public TypeElement getTypeElement(String className)

Gets the TypeElement for a given class name.

Throws:

NoClassDefFoundError - if the class cannot be resolved

getTypeElementOrNull

public TypeElement getTypeElementOrNull(String className)

Gets the TypeElement for a given class name.

Returns:

null if the class cannot be resolved

asTypeElement

public TypeElement asTypeElement(TypeMirror type)

Converts a given TypeMirror to a TypeElement.

Throws:

ClassCastException - if type cannot be converted to a TypeElement

getSimpleName

public static String getSimpleName(String className)

Gets the non-package component of a qualified class name.

Throws:

IllegalArgumentException - if className does not match QUALIFIED_CLASS_NAME_RE

getPackageName

public static String getPackageName(String className)

Gets the package component of a qualified class name.

Throws:

IllegalArgumentException - if className does not match QUALIFIED_CLASS_NAME_RE

getAnnotation

public AnnotationMirror getAnnotation(Element element,
 TypeMirror annotationType)

Gets the annotation of type annotationType directly present on element.

Returns:

null if an annotation of type annotationType is not on element

getAnnotations

public List<AnnotationMirror> getAnnotations(Element element,
 TypeMirror typeMirror)

Gets all annotations directly present on element.

getAnnotationValue

public static <T> T getAnnotationValue(AnnotationMirror annotation,
 String name,
 Class<T> type)

Gets the value of the name element of annotation and converts it to a value of type type.

Parameters:

type - the expected type of the element value. This must be a subclass of one of the types described by AnnotationValue.

Throws:

NoSuchElementException - if annotation has no element named name

ClassCastException - if the value of the specified element cannot be converted to type

getAnnotationValueList

public static <T> List<T> getAnnotationValueList(AnnotationMirror annotation,
 String name,
 Class<T> componentType)

Gets the value of the name array-typed element of annotation and converts it to list of values of type type.

Parameters:

componentType - the expected component type of the element value. This must be a subclass of one of the types described by AnnotationValue.

Throws:

NoSuchElementException - if annotation has no element named name

ClassCastException - if the value of the specified element is not an array whose components cannot be converted to componentType

getPackage

public static PackageElement getPackage(Element element)

createSourceFile

public static PrintWriter createSourceFile(String pkg,
 String relativeName,
 Filer filer,
 Element... originatingElements)

createProviderFile

public void createProviderFile(String providerClassName,
 String serviceClassName,
 Element... originatingElements)

Creates a META-INF/providers/<providerClassName> file whose contents are a single line containing serviceClassName.