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

java.lang.Object
io.helidon.metrics.api.ScopingConfig.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:
ScopingConfig.Builder
Enclosing interface:
ScopingConfig
public abstract static class ScopingConfig.BuilderBase<BUILDER extends ScopingConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends ScopingConfig> extends Object implements ConfigBuilderSupport.ConfiguredBuilder<BUILDER, PROTOTYPE>
Fluent API builder base for ScopingConfig.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    protected static class 
    ScopingConfig.BuilderBase.ScopingConfigImpl
    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
    addScopes(Map<String, ? extends ScopeConfig> scopes)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Core metrics ignores these settings, and this method will be removed.
    BUILDER
    clearDefaultValue()
    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
    clearTagName()
    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).
    Optional<String>
    defaultValue()
    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
    defaultValue(String defaultValue)
    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(ScopingConfig prototype)
    Update this builder from an existing prototype instance.
    BUILDER
    from(ScopingConfig.BuilderBase<?,?> builder)
    Update this builder from an existing prototype builder instance.
    protected void
    preBuildPrototype()
    Handles providers and decorators.
    BUILDER
    putScope(String key, ScopeConfig scope)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Core metrics ignores these settings, and this method will be removed.
    BUILDER
    putScope(String key, Consumer<ScopeConfig.Builder> consumer)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Core metrics ignores these settings, and this method will be removed.
    Map<String, ScopeConfig>
    scopes()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Core metrics ignores these settings, and this method will be removed.
    BUILDER
    scopes(Map<String, ? extends ScopeConfig> scopes)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Core metrics ignores these settings, and this method will be removed.
    Optional<String>
    tagName()
    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
    tagName(String tagName)
    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.
    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(ScopingConfig 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(ScopingConfig.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

    • 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 ScopingConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends ScopingConfig>
      Parameters:
      config - configuration instance used to obtain values to update this builder
      Returns:
      updated builder instance

    • clearDefaultValue

      @Deprecated(since="27.0.0", forRemoval=true) public BUILDER clearDefaultValue()
      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 defaultValue.
      Returns:
      updated builder instance
      See Also:

    • defaultValue

      @Deprecated(since="27.0.0", forRemoval=true) public BUILDER defaultValue(String defaultValue)
      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 default scope value.
      Parameters:
      defaultValue - configured default scope value
      Returns:
      updated builder instance
      See Also:

    • clearTagName

      @Deprecated(since="27.0.0", forRemoval=true) public BUILDER clearTagName()
      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 tagName.
      Returns:
      updated builder instance
      See Also:

    • tagName

      @Deprecated(since="27.0.0", forRemoval=true) public BUILDER tagName(String tagName)
      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 tag name.
      Parameters:
      tagName - configured scope tag name
      Returns:
      updated builder instance
      See Also:

    • scopes

      @Deprecated(since="27.0.0", forRemoval=true) public BUILDER scopes(Map<String, ? extends ScopeConfig> scopes)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Core metrics ignores these settings, and this method will be removed.
      Returns the configured settings for individual scopes. This method replaces all values with the new ones.
      Parameters:
      scopes - configured scope settings
      Returns:
      updated builder instance
      See Also:

    • addScopes

      @Deprecated(since="27.0.0", forRemoval=true) public BUILDER addScopes(Map<String, ? extends ScopeConfig> scopes)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Core metrics ignores these settings, and this method will be removed.
      Returns the configured settings for individual scopes. This method keeps existing values, then puts all new values into the map.
      Parameters:
      scopes - configured scope settings
      Returns:
      updated builder instance
      See Also:

    • putScope

      @Deprecated(since="27.0.0", forRemoval=true) public BUILDER putScope(String key, ScopeConfig scope)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Core metrics ignores these settings, and this method will be removed.
      Returns the configured settings for individual scopes. This method adds a new value to the map, or replaces it if the key already exists.
      Parameters:
      key - key to add or replace
      scope - new value for the key
      Returns:
      updated builder instance
      See Also:

    • putScope

      @Deprecated(since="27.0.0", forRemoval=true) public BUILDER putScope(String key, Consumer<ScopeConfig.Builder> consumer)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Core metrics ignores these settings, and this method will be removed.
      Returns the configured settings for individual scopes. This method adds a new value to the map, or replaces it if the key already exists.
      Parameters:
      key - key to add or replace
      consumer - consumer of builder for new value
      Returns:
      updated builder instance
      See Also:

    • defaultValue

      @Deprecated(since="27.0.0", forRemoval=true) public Optional<String> defaultValue()
      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 default scope value.
      Returns:
      configured default scope value

    • tagName

      @Deprecated(since="27.0.0", forRemoval=true) public Optional<String> tagName()
      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 tag name.
      Returns:
      configured scope tag name

    • scopes

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

    • 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