Class PluginBuilder

java.lang.Object
org.apache.logging.log4j.core.config.plugins.util.PluginBuilder
All Implemented Interfaces:
Builder<Object>
public class PluginBuilder extends Object implements Builder<Object>
Builder class to instantiate and configure a Plugin object using a PluginFactory method or PluginBuilderFactory builder class.

  • Constructor Details

    • PluginBuilder

      public PluginBuilder(PluginType<?> pluginType)
      Constructs a PluginBuilder for a given PluginType.
      Parameters:
      pluginType - type of plugin to configure

  • Method Details

    • withConfiguration

      public PluginBuilder withConfiguration(Configuration configuration)
      Specifies the Configuration to use for constructing the plugin instance.
      Parameters:
      configuration - the configuration to use.
      Returns:
      this

    • withConfigurationNode

      public PluginBuilder withConfigurationNode(Node node)
      Specifies the Node corresponding to the plugin object that will be created.
      Parameters:
      node - the plugin configuration node to use.
      Returns:
      this

    • forLogEvent

      public PluginBuilder forLogEvent(LogEvent event)
      Specifies the LogEvent that may be used to provide extra context for string substitutions.
      Parameters:
      event - the event to use for extra information.
      Returns:
      this

    • build

      public Object build()
      Builds the plugin object.
      Specified by:
      build in interface Builder<Object>
      Returns:
      the plugin object or null if there was a problem creating it.

    • validateFields

      public static boolean validateFields(Builder<?> builder, String errorPrefix)