Package org.apache.logging.log4j.plugins

Annotation Interface PluginValue

@Documented @Retention(RUNTIME) @Target({PARAMETER,FIELD,METHOD,TYPE_USE}) @NameProvider(PluginValueNameProvider.class) @QualifierType public @interface PluginValue
Identifies a Plugin Value and its corresponding attribute alias for configuration formats that don't distinguish between values and attributes. A value is typically used differently from an attribute in that it is either the main configuration value required or it is the only value needed to create a plugin. A plugin value can be injected as a parameter to a static factory method, or as a field or single-parameter method in a plugin builder class.

For example, a Property plugin corresponds to a property entry in a configuration file. The property name is specified as an attribute, and the property value is specified as a value.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    value
    Specifies the case-insensitive attribute name to use in configuration formats that don't distinguish between attributes and values.

  • Element Details

    • value

      String value
      Specifies the case-insensitive attribute name to use in configuration formats that don't distinguish between attributes and values. By default, this uses the attribute name value.
      Returns:
      the value of the attribute.
      Default:
      "value"