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

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

  • 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 Prototype.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

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

    • defaultValue

      public BUILDER defaultValue(String defaultValue)
      Default scope value to associate with meters that are registered without an explicit setting; no setting means meters are assigned scope "application".
      Parameters:
      defaultValue - default scope value
      Returns:
      updated builder instance
      See Also:

    • clearTagName

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

    • tagName

      public BUILDER tagName(String tagName)
      Tag name for storing meter scope values in the underlying implementation meter registry.
      Parameters:
      tagName - tag name for storing scope values
      Returns:
      updated builder instance
      See Also:

    • scopes

      public BUILDER scopes(Map<? extends String,? extends ScopeConfig> scopes)
      This method replaces all values with the new ones.
      Parameters:
      scopes - scope settings
      Returns:
      updated builder instance
      See Also:

    • addScopes

      public BUILDER addScopes(Map<? extends String,? extends ScopeConfig> scopes)
      This method keeps existing values, then puts all new values into the map.
      Parameters:
      scopes - scope settings
      Returns:
      updated builder instance
      See Also:

    • putScope

      public BUILDER putScope(String key, ScopeConfig scope)
      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

      public BUILDER putScope(String key, Consumer<ScopeConfig.Builder> consumer)
      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 - builder consumer to create new value for the key
      Returns:
      updated builder instance
      See Also:

    • defaultValue

      public Optional<String> defaultValue()
      Default scope value to associate with meters that are registered without an explicit setting; no setting means meters are assigned scope "application".
      Returns:
      the default value

    • tagName

      public Optional<String> tagName()
      Tag name for storing meter scope values in the underlying implementation meter registry.
      Returns:
      the tag name

    • scopes

      public Map<String,ScopeConfig> scopes()
      Settings for individual scopes.
      Returns:
      the scopes

    • 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.