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.


Required Element Summary
 String category
          Category to place the plugin under.
 String name
          Name of the plugin.
 
Optional Element Summary
 boolean deferChildren
           
 String elementType
          Name of the corresponding category of elements this plugin belongs under.
 boolean printObject
           
 

Element Detail

name

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


category

public abstract String category
Category to place the plugin under. Category names are case-sensitive.

elementType

public abstract 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
Default:
false

deferChildren

public abstract boolean deferChildren
Default:
false


Copyright © 1999-2014 Apache Software Foundation. All Rights Reserved.
Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.