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

Annotation Type Plugin

@Documented @Retention(RUNTIME) @Target(TYPE) public @interface Plugin
Annotation that identifies a Class as a Plugin.

  • Required Element Summary

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

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    deferChildren
     
    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 Summary

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

  • Field Details

  • Element Details

    • name

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

    • category

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

    • elementType

      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

      boolean printObject
      Indicates if the plugin class implements a useful Object.toString() method for use in log messages.
      Default:
      false

    • deferChildren

      boolean deferChildren
      Default:
      false