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>, ConfigBuilderSupport.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 ConfigBuilderSupport.ConfiguredBuilder<BUILDER, PROTOTYPE>
Fluent API builder base for ScopeConfig.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    protected static class 
    ScopeConfig.BuilderBase.ScopeConfigImpl
    Generated implementation of the prototype, can be extended by descendant prototype implementations.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    BuilderBase()
    Protected to support extensibility.

  • Method Summary

    Modifier and Type
    Method
    Description
    BUILDER
    clearExclude()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Core metrics ignores this value, and this method will be removed.
    BUILDER
    clearInclude()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Core metrics ignores this value, and this method will be removed.
    protected Optional<Config>
    config()
    Configuration used to configure this instance.
    BUILDER
    config(Config config)
    Update builder from configuration (node of this type).
    boolean
    enabled()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Core metrics ignores this value, and this method will be removed.
    BUILDER
    enabled(boolean enabled)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Core metrics ignores this value, and this method will be removed.
    Optional<Pattern>
    exclude()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Core metrics ignores this value, and this method will be removed.
    BUILDER
    exclude(String excludeString)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Use exclude(Pattern).
    BUILDER
    exclude(Pattern exclude)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Core metrics ignores this value, and this method will be removed.
    BUILDER
    from(ScopeConfig prototype)
    Update this builder from an existing prototype instance.
    BUILDER
    from(ScopeConfig.BuilderBase<?,?> builder)
    Update this builder from an existing prototype builder instance.
    Optional<Pattern>
    include()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Core metrics ignores this value, and this method will be removed.
    BUILDER
    include(String includeString)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Use include(Pattern).
    BUILDER
    include(Pattern include)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Core metrics ignores this value, and this method will be removed.
    Optional<String>
    name()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Core metrics ignores this value, and this method will be removed.
    BUILDER
    name(String name)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Core metrics ignores this value, and this method will be removed.
    protected void
    preBuildPrototype()
    Handles providers and decorators.
    String
    toString()
     
    protected void
    validatePrototype()
    Validates required properties.

    Methods inherited from class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface Prototype.Builder

    buildPrototype, self
    Modifier and Type
    Method
    Description
    PROTOTYPE
    buildPrototype()
    Create an instance of the Prototype.
    default BUILDER
    self()
    Instance of this builder as the correct type.

  • 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

      @Deprecated(forRemoval=true, since="27.0.0") public BUILDER include(String includeString)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use include(Pattern). Core metrics ignores scope configuration, and this method will be removed.
      Sets the retained meter-name inclusion pattern from a string; core metrics ignores the setting.
      Parameters:
      includeString - inclusion pattern
      Returns:
      updated builder instance

    • exclude

      @Deprecated(forRemoval=true, since="27.0.0") public BUILDER exclude(String excludeString)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use exclude(Pattern). Core metrics ignores scope configuration, and this method will be removed.
      Sets the retained meter-name exclusion pattern from a string; core metrics ignores the setting.
      Parameters:
      excludeString - exclusion pattern
      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 ConfigBuilderSupport.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

      @Deprecated(since="27.0.0", forRemoval=true) public BUILDER name(String name)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Core metrics ignores this value, and this method will be removed.
      Returns the configured scope name.
      Parameters:
      name - configured scope name
      Returns:
      updated builder instance
      See Also:

    • enabled

      @Deprecated(since="27.0.0", forRemoval=true) public BUILDER enabled(boolean enabled)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Core metrics ignores this value, and this method will be removed.
      Returns whether the scope is configured as enabled.
      Parameters:
      enabled - configured value
      Returns:
      updated builder instance
      See Also:

    • clearInclude

      @Deprecated(since="27.0.0", forRemoval=true) public BUILDER clearInclude()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Core metrics ignores this value, and this method will be removed.
      Clear existing value of include.
      Returns:
      updated builder instance
      See Also:

    • include

      @Deprecated(since="27.0.0", forRemoval=true) public BUILDER include(Pattern include)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Core metrics ignores this value, and this method will be removed.
      Returns the configured meter-name inclusion pattern.
      Parameters:
      include - configured inclusion pattern
      Returns:
      updated builder instance
      See Also:

    • clearExclude

      @Deprecated(since="27.0.0", forRemoval=true) public BUILDER clearExclude()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Core metrics ignores this value, and this method will be removed.
      Clear existing value of exclude.
      Returns:
      updated builder instance
      See Also:

    • exclude

      @Deprecated(since="27.0.0", forRemoval=true) public BUILDER exclude(Pattern exclude)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Core metrics ignores this value, and this method will be removed.
      Returns the configured meter-name exclusion pattern.
      Parameters:
      exclude - configured exclusion pattern
      Returns:
      updated builder instance
      See Also:

    • name

      @Deprecated(since="27.0.0", forRemoval=true) public Optional<String> name()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Core metrics ignores this value, and this method will be removed.
      Returns the configured scope name.
      Returns:
      configured scope name

    • enabled

      @Deprecated(since="27.0.0", forRemoval=true) public boolean enabled()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Core metrics ignores this value, and this method will be removed.
      Returns whether the scope is configured as enabled.
      Returns:
      configured value

    • include

      @Deprecated(since="27.0.0", forRemoval=true) public Optional<Pattern> include()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Core metrics ignores this value, and this method will be removed.
      Returns the configured meter-name inclusion pattern.
      Returns:
      configured inclusion pattern

    • exclude

      @Deprecated(since="27.0.0", forRemoval=true) public Optional<Pattern> exclude()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Core metrics ignores this value, and this method will be removed.
      Returns the configured meter-name exclusion pattern.
      Returns:
      configured exclusion pattern

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • preBuildPrototype

      protected void preBuildPrototype()
      Handles providers and decorators.

    • validatePrototype

      protected void validatePrototype()
      Validates required properties.

    • config

      protected Optional<Config> config()
      Configuration used to configure this instance.
      Returns:
      config instance