Annotation Type Plugin


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

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

      Required Elements 
      Modifier and Type Required Element 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 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

        static final java.lang.String EMPTY
        Value of the elementType when none is specified.
    • Element Detail

      • name

        java.lang.String name
        Name of the plugin. Note that this name is case-insensitive.
      • category

        java.lang.String category
        Category to place the plugin under. Category names are case-sensitive.
      • elementType

        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

        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