Module io.helidon.integrations.openapi.ui
Package io.helidon.integrations.openapi.ui

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

java.lang.Object
io.helidon.integrations.openapi.ui.OpenApiUiConfig.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>, ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>
Direct Known Subclasses:
OpenApiUiConfig.Builder
Enclosing interface:
OpenApiUiConfig
public abstract static class OpenApiUiConfig.BuilderBase<BUILDER extends OpenApiUiConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends OpenApiUiConfig> extends Object implements ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>
Fluent API builder base for OpenApiUiConfig.

  • Constructor Details

    • BuilderBase

      protected BuilderBase()
      Protected to support extensibility.

  • Method Details

    • from

      public BUILDER from(OpenApiUiConfig 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(OpenApiUiConfig.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

      @Deprecated public BUILDER config(Config config)
      Deprecated.
      use config(io.helidon.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 OpenApiUiConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends OpenApiUiConfig>
      Parameters:
      config - configuration instance used to obtain values to update this builder
      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 OpenApiUiConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends OpenApiUiConfig>
      Parameters:
      config - configuration instance used to obtain values to update this builder
      Returns:
      updated builder instance

    • options

      public BUILDER options(Map<String,String> options)
      Merges implementation-specific UI options. This method replaces all values with the new ones.
      Parameters:
      options - options for the UI to merge
      Returns:
      updated builder instance
      See Also:

    • addOptions

      public BUILDER addOptions(Map<String,String> options)
      Merges implementation-specific UI options. This method keeps existing values, then puts all new values into the map.
      Parameters:
      options - options for the UI to merge
      Returns:
      updated builder instance
      See Also:

    • isEnabled

      public BUILDER isEnabled(boolean isEnabled)
      Sets whether the service should be enabled.
      Parameters:
      isEnabled - true if enabled, false otherwise
      Returns:
      updated builder instance
      See Also:

    • clearWebContext

      public BUILDER clearWebContext()
      Clear existing value of webContext.
      Returns:
      updated builder instance
      See Also:

    • webContext

      public BUILDER webContext(String webContext)
      Full web context (not just the suffix).
      Parameters:
      webContext - full web context path
      Returns:
      updated builder instance
      See Also:

    • options

      public Map<String,String> options()
      Merges implementation-specific UI options.
      Returns:
      options for the UI to merge

    • isEnabled

      public boolean isEnabled()
      Sets whether the service should be enabled.
      Returns:
      true if enabled, false otherwise

    • webContext

      public Optional<String> webContext()
      Full web context (not just the suffix).
      Returns:
      full web context path

    • 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