Class GraalVmProcessor

java.lang.Object

javax.annotation.processing.AbstractProcessor

org.apache.logging.log4j.core.config.plugins.processor.GraalVmProcessor

All Implemented Interfaces:

Processor

@SupportedAnnotationTypes({"org.apache.logging.log4j.core.config.plugins.validation.Constraint","org.apache.logging.log4j.core.config.plugins.Plugin","org.apache.logging.log4j.core.config.plugins.PluginBuilderAttribute","org.apache.logging.log4j.core.config.plugins.PluginBuilderFactory","org.apache.logging.log4j.core.config.plugins.PluginConfiguration","org.apache.logging.log4j.core.config.plugins.PluginElement","org.apache.logging.log4j.core.config.plugins.PluginFactory","org.apache.logging.log4j.core.config.plugins.PluginLoggerContext","org.apache.logging.log4j.core.config.plugins.PluginNode","org.apache.logging.log4j.core.config.plugins.PluginValue","org.apache.logging.log4j.core.config.plugins.PluginVisitorStrategy"})
@SupportedOptions({"log4j.graalvm.groupId","log4j.graalvm.artifactId"})
public class GraalVmProcessor
extends AbstractProcessor

Java annotation processor that generates GraalVM metadata.

Note: The annotations listed here must also be classified by the Annotations helper.

Field Summary

Fields

Modifier and Type	Field	Description
private Annotations	annotationUtil
(package private) static final String	ARTIFACT_ID
(package private) static final String	GROUP_ID
private static final String	LOCATION_PREFIX
private static final String	LOCATION_SUFFIX
private final List<Element>	processedElements
private static final String	PROCESSOR_NAME
private final Map<String, ReachabilityMetadata.Type>	reachableTypes

Fields inherited from class AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor	Description
GraalVmProcessor()

Method Summary

Modifier and Type	Method	Description
private void	addField(TypeElement parent, VariableElement element)
private void	addMethod(TypeElement parent, ExecutableElement element)
(package private) String	getReachabilityMetadataPath(@Nullable String groupId, @Nullable String artifactId, String fallbackFolderName)	Returns the path to the reachability metadata file.
SourceVersion	getSupportedSourceVersion()
void	init(ProcessingEnvironment processingEnv)
boolean	process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv)
private void	processConstraintOrVisitor(Element element, TypeElement annotation)
private void	processFactory(Element element)
private void	processParameter(Element element)
private void	processPlugin(Element element)
private <T extends Element> T	safeCast(Element element, Class<T> type)
private String	toString(TypeElement element)	Returns the fully qualified name of the element corresponding to a DeclaredType.
private String	toString(TypeMirror type)	Returns the fully qualified name of a type.
private void	writeReachabilityMetadata()

Methods inherited from class AbstractProcessor

getCompletions, getSupportedAnnotationTypes, getSupportedOptions, isInitialized

Methods inherited from class Object

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

Field Details

GROUP_ID

static final String GROUP_ID

See Also:

• Constant Field Values

ARTIFACT_ID

static final String ARTIFACT_ID

See Also:

• Constant Field Values

LOCATION_PREFIX

private static final String LOCATION_PREFIX

See Also:

• Constant Field Values

LOCATION_SUFFIX

private static final String LOCATION_SUFFIX

See Also:

• Constant Field Values

PROCESSOR_NAME

private static final String PROCESSOR_NAME

reachableTypes

private final Map<String, ReachabilityMetadata.Type> reachableTypes

processedElements

private final List<Element> processedElements

annotationUtil

private Annotations annotationUtil

Constructor Details

GraalVmProcessor

public GraalVmProcessor()

Method Details

init

public void init(ProcessingEnvironment processingEnv)

Specified by:

init in interface Processor

Overrides:

init in class AbstractProcessor

getSupportedSourceVersion

public 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

processPlugin

private void processPlugin(Element element)

processConstraintOrVisitor

private void processConstraintOrVisitor(Element element,
 TypeElement annotation)

processParameter

private void processParameter(Element element)

processFactory

private void processFactory(Element element)

writeReachabilityMetadata

private void writeReachabilityMetadata()

getReachabilityMetadataPath

String getReachabilityMetadataPath(@Nullable String groupId,
 @Nullable String artifactId,
 String fallbackFolderName)

Returns the path to the reachability metadata file.

If the groupId or artifactId is not specified, a warning is printed and a fallback folder name is used. The fallback folder name should be reproducible, but unique enough to avoid conflicts.

Parameters:

groupId - The group ID of the plugin.

artifactId - The artifact ID of the plugin.

fallbackFolderName - The fallback folder name to use if groupId or artifactId is not specified.

addField

private void addField(TypeElement parent,
 VariableElement element)

addMethod

private void addMethod(TypeElement parent,
 ExecutableElement element)

safeCast

private <T extends Element> T safeCast(Element element,
 Class<T> type)

toString

private String toString(TypeMirror type)

Returns the fully qualified name of a type.

Parameters:

type - A Java type.

toString

private String toString(TypeElement element)

Returns the fully qualified name of the element corresponding to a DeclaredType.

Parameters:

element - A Java language element.