Module io.helidon.integrations.openapi.ui

Package io.helidon.integrations.openapi.ui

Interface OpenApiUiConfig

All Superinterfaces:

Prototype.Api, Prototype.Factory<OpenApiUi>

All Known Implementing Classes:

OpenApiUiConfig.BuilderBase.OpenApiUiConfigImpl

public interface OpenApiUiConfig
extends Prototype.Api

OpenApiUi prototype.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	OpenApiUiConfig.Builder	Fluent API builder for OpenApiUi.
static class	OpenApiUiConfig.BuilderBase<BUILDER extends OpenApiUiConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends OpenApiUiConfig>	Fluent API builder base for OpenApiUi.

Method Summary

Modifier and Type	Method	Description
static OpenApiUiConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static OpenApiUiConfig.Builder	builder(OpenApiUiConfig instance)	Create a new fluent API builder from an existing instance.
static OpenApiUiConfig	create()	Create a new instance with default values.
static OpenApiUiConfig	create(Config config)	Create a new instance from configuration.
boolean	isEnabled()	Sets whether the service should be enabled.
Map<String,String>	options()	Merges implementation-specific UI options.
Optional<String>	webContext()	Full web context (not just the suffix).

Methods inherited from interface io.helidon.builder.api.Prototype.Factory

build

Method Details

builder

static OpenApiUiConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static OpenApiUiConfig.Builder builder(OpenApiUiConfig instance)

Create a new fluent API builder from an existing instance.

Parameters:

instance - an existing instance used as a base for the builder

Returns:

a builder based on an instance

create

static OpenApiUiConfig create(Config config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

create

static OpenApiUiConfig create()

Create a new instance with default values.

Returns:

a new instance

options

Map<String,String> options()

Merges implementation-specific UI options.

Returns:

options for the UI to merge

isEnabled

boolean isEnabled()

Sets whether the service should be enabled.

Returns:

true if enabled, false otherwise

webContext

Optional<String> webContext()

Full web context (not just the suffix).

Returns:

full web context path