Module io.helidon.metrics.api
Package io.helidon.metrics.api

Class ScopeConfig.BuilderBase<BUILDER extends ScopeConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ScopeConfig>

java.lang.Object
io.helidon.metrics.api.ScopeConfig.BuilderBase<BUILDER,PROTOTYPE>
Type Parameters:
BUILDER - type of the builder extending this abstract builder
PROTOTYPE - type of the prototype interface that would be built by Prototype.Builder.buildPrototype()
All Implemented Interfaces:
Prototype.Builder<BUILDER,PROTOTYPE>, Prototype.ConfiguredBuilder<BUILDER,PROTOTYPE>
Direct Known Subclasses:
ScopeConfig.Builder
Enclosing interface:
ScopeConfig
public abstract static class ScopeConfig.BuilderBase<BUILDER extends ScopeConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ScopeConfig> extends Object implements Prototype.ConfiguredBuilder<BUILDER,PROTOTYPE>
Fluent API builder base for ScopeConfig.

  • Constructor Details

    • BuilderBase

      protected BuilderBase()
      Protected to support extensibility.

  • Method Details

    • from

      public BUILDER from(ScopeConfig prototype)
      Update this builder from an existing prototype instance. This method disables automatic service discovery.
      Parameters:
      prototype - existing prototype to update this builder from
      Returns:
      updated builder instance

    • from

      public BUILDER from(ScopeConfig.BuilderBase<?,?> builder)
      Update this builder from an existing prototype builder instance.
      Parameters:
      builder - existing builder prototype to update this builder from
      Returns:
      updated builder instance

    • include

      public BUILDER include(String includeString)
      Sets the include expression using a String compiled automatically into a Pattern.
      Parameters:
      includeString - include string
      Returns:
      updated builder instance

    • exclude

      public BUILDER exclude(String excludeString)
      Sets the exclude expression using a String compiled automatically into a Pattern.
      Parameters:
      excludeString - exclude string
      Returns:
      updated builder instance

    • config

      public BUILDER config(Config config)
      Update builder from configuration (node of this type). If a value is present in configuration, it would override currently configured values.
      Specified by:
      config in interface Prototype.ConfiguredBuilder<BUILDER extends ScopeConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ScopeConfig>
      Parameters:
      config - configuration instance used to obtain values to update this builder
      Returns:
      updated builder instance

    • name

      public BUILDER name(String name)
      Name of the scope to which the configuration applies.
      Parameters:
      name - scope name
      Returns:
      updated builder instance
      See Also:

    • enabled

      public BUILDER enabled(boolean enabled)
      Whether the scope is enabled.
      Parameters:
      enabled - if the scope is enabled
      Returns:
      updated builder instance
      See Also:

    • clearInclude

      public BUILDER clearInclude()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • include

      public BUILDER include(Pattern include)
      Regular expression for meter names to include.
      Parameters:
      include - include expression
      Returns:
      updated builder instance
      See Also:

    • clearExclude

      public BUILDER clearExclude()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • exclude

      public BUILDER exclude(Pattern exclude)
      Regular expression for meter names to exclude.
      Parameters:
      exclude - exclude expression
      Returns:
      updated builder instance
      See Also:

    • name

      public Optional<String> name()
      Name of the scope to which the configuration applies.
      Returns:
      the name

    • enabled

      public boolean enabled()
      Whether the scope is enabled.
      Returns:
      the enabled

    • include

      public Optional<Pattern> include()
      Regular expression for meter names to include.
      Returns:
      the include

    • exclude

      public Optional<Pattern> exclude()
      Regular expression for meter names to exclude.
      Returns:
      the exclude

    • config

      public Optional<Config> config()
      If this instance was configured, this would be the config instance used.
      Returns:
      config node used to configure this builder, or empty if not configured

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • preBuildPrototype

      protected void preBuildPrototype()
      Handles providers and decorators.

    • validatePrototype

      protected void validatePrototype()
      Validates required properties.