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

Annotation Type Plugin

@Documented
 @Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface Plugin

Annotation that identifies a Class as a Plugin.

Field Summary

Fields

Modifier and Type	Fields and Description
static java.lang.String	EMPTY Value of the elementType when none is specified.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	category Category to place the plugin under.
java.lang.String	name Name of the plugin.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	deferChildren
java.lang.String	elementType Name of the corresponding category of elements this plugin belongs under.
boolean	printObject Indicates if the plugin class implements a useful Object.toString() method for use in log messages.

Field Detail

EMPTY

public static final java.lang.String EMPTY

Value of the elementType when none is specified.

Element Detail

name

public abstract java.lang.String name

Name of the plugin. Note that this name is case-insensitive.

category

public abstract java.lang.String category

Category to place the plugin under. Category names are case-sensitive.

elementType

public abstract java.lang.String elementType

Name of the corresponding category of elements this plugin belongs under. For example, appender would indicate an Appender plugin which would be in the <Appenders/> element of a Configuration.

Default:

""

printObject

public abstract boolean printObject

Indicates if the plugin class implements a useful Object.toString() method for use in log messages.

Default:

false

deferChildren

public abstract boolean deferChildren

Default:

false