Module io.helidon.microprofile.openapi
Package io.helidon.microprofile.openapi

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

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

  • Constructor Details

    • BuilderBase

      protected BuilderBase()
      Protected to support extensibility.

  • Method Details

    • from

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

    • useJaxRsSemantics

      public BUILDER useJaxRsSemantics(boolean useJaxRsSemantics)
      If true and the jakarta.ws.rs.core.Application class returns a non-empty set, endpoints defined by other resources are not included in the OpenAPI document.
      Parameters:
      useJaxRsSemantics - true if enabled, false otherwise
      Returns:
      updated builder instance
      See Also:

    • indexPaths

      public BUILDER indexPaths(List<? extends String> indexPaths)
      Specify the set of Jandex index path.
      Parameters:
      indexPaths - list of Jandex index path
      Returns:
      updated builder instance
      See Also:

    • addIndexPaths

      public BUILDER addIndexPaths(List<? extends String> indexPaths)
      Specify the set of Jandex index path.
      Parameters:
      indexPaths - list of Jandex index path
      Returns:
      updated builder instance
      See Also:

    • useJaxRsSemantics

      public boolean useJaxRsSemantics()
      If true and the jakarta.ws.rs.core.Application class returns a non-empty set, endpoints defined by other resources are not included in the OpenAPI document.
      Returns:
      the use jax rs semantics

    • indexPaths

      public List<String> indexPaths()
      Specify the set of Jandex index path.
      Returns:
      the index paths

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