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

Class PluginProcessor

java.lang.Object

javax.annotation.processing.AbstractProcessor

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

All Implemented Interfaces:

Processor

@SupportedAnnotationTypes("org.apache.logging.log4j.core.config.plugins.Plugin")
@SupportedOptions("log4j.plugin.processor.minAllowedMessageKind")
public class PluginProcessor
extends AbstractProcessor

Annotation processor for pre-scanning Log4j 2 plugins.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	PluginProcessor.PluginAliasesElementVisitor	ElementVisitor to scan the PluginAliases annotation.
private static final class	PluginProcessor.PluginElementVisitor	ElementVisitor to scan the Plugin annotation.

Field Summary

Fields

Modifier and Type	Field	Description
private static final Element[]	EMPTY_ELEMENT_ARRAY
(package private) static final String	MIN_ALLOWED_MESSAGE_KIND_OPTION	Annotation processor option that controls the minimum Diagnostic.Kind of messages emitted by this processor.
private Diagnostic.Kind	minAllowedMessageKind
private static final String	PLUGIN_BUILDER_ATTRIBUTE_ANNOTATION
static final String	PLUGIN_CACHE_FILE	The location of the plugin cache data file.
private final PluginCache	pluginCache
private final List<Element>	processedElements
private static final String	SUPPRESS_WARNING_PUBLIC_SETTER_STRING

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor	Description
PluginProcessor()

Method Summary

Modifier and Type	Method	Description
private void	collectPlugins(Iterable<? extends Element> elements)
private static String	expectedFieldNameInASetter(String fieldName)	Helper method to get the expected Method name in a field.
SourceVersion	getSupportedSourceVersion()
void	init(ProcessingEnvironment processingEnv)
private void	printMessage(Diagnostic.Kind kind, String message)	Prints a message via the Messager only if kind is at least as severe as the configured minimum allowed kind.
private void	printMessage(Diagnostic.Kind kind, String message, Element element)	Prints a message via the Messager only if kind is at least as severe as the configured minimum allowed kind.
boolean	process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv)
private void	processBuilderAttribute(Iterable<? extends Element> elements)
private void	processBuilderAttribute(VariableElement element)
private void	writeCacheFile(Element... elements)

Methods inherited from class javax.annotation.processing.AbstractProcessor

getCompletions, getSupportedAnnotationTypes, getSupportedOptions, isInitialized

Methods inherited from class java.lang.Object

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

Field Details

EMPTY_ELEMENT_ARRAY

private static final Element[] EMPTY_ELEMENT_ARRAY

SUPPRESS_WARNING_PUBLIC_SETTER_STRING

private static final String SUPPRESS_WARNING_PUBLIC_SETTER_STRING

See Also:

• Constant Field Values

MIN_ALLOWED_MESSAGE_KIND_OPTION

static final String MIN_ALLOWED_MESSAGE_KIND_OPTION

Annotation processor option that controls the minimum Diagnostic.Kind of messages emitted by this processor.

Some build environments (e.g. Maven with -Werror) treat compiler notes or warnings as errors. Setting this option to WARNING or ERROR suppresses informational notes emitted during normal processing.

Accepted values (case-insensitive): NOTE, WARNING, MANDATORY_WARNING, ERROR, OTHER. Defaults to NOTE.

See Also:

• Constant Field Values

PLUGIN_CACHE_FILE

public static final String PLUGIN_CACHE_FILE

The location of the plugin cache data file. This file is written to by this processor, and read from by PluginManager.

See Also:

• Constant Field Values

processedElements

private final List<Element> processedElements

pluginCache

private final PluginCache pluginCache

minAllowedMessageKind

private Diagnostic.Kind minAllowedMessageKind

PLUGIN_BUILDER_ATTRIBUTE_ANNOTATION

private static final String PLUGIN_BUILDER_ATTRIBUTE_ANNOTATION

See Also:

• Constant Field Values

Constructor Details

PluginProcessor

public PluginProcessor()

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

printMessage

private void printMessage(Diagnostic.Kind kind,
 String message)

Prints a message via the Messager only if kind is at least as severe as the configured minimum allowed kind.

printMessage

private void printMessage(Diagnostic.Kind kind,
 String message,
 Element element)

Prints a message via the Messager only if kind is at least as severe as the configured minimum allowed kind.

process

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

Specified by:

process in interface Processor

Specified by:

process in class AbstractProcessor

processBuilderAttribute

private void processBuilderAttribute(Iterable<? extends Element> elements)

processBuilderAttribute

private void processBuilderAttribute(VariableElement element)

expectedFieldNameInASetter

private static String expectedFieldNameInASetter(String fieldName)

Helper method to get the expected Method name in a field. For example if the field name is 'isopen', then the expected setter would be 'setOpen' or 'withOpen' This method is supposed to return the capitalized 'Open', fieldName which is expected in the setter.

Parameters:

fieldName - who's setter we are checking.

Returns:

The expected fieldName that will come after withxxxx or setxxxx

collectPlugins

private void collectPlugins(Iterable<? extends Element> elements)

writeCacheFile

private void writeCacheFile(Element... elements)
                     throws IOException

Throws:

IOException