Interface OpenApi31VersionConfig

All Superinterfaces:

Prototype.Api, Prototype.Factory<OpenApi31Version>

All Known Implementing Classes:

OpenApi31VersionConfig.BuilderBase.OpenApi31VersionConfigImpl

public interface OpenApi31VersionConfig
extends Prototype.Api

OpenAPI 3.1 version configuration.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static OpenApi31VersionConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static OpenApi31VersionConfig.Builder	builder(OpenApi31VersionConfig instance)	Create a new fluent API builder from an existing instance.
static OpenApi31VersionConfig	create()	Create a new instance with default values.
static OpenApi31VersionConfig	create(Config config)	Create a new instance from configuration.
String	name()	Name of this version configuration.
String	version()	Exact OpenAPI 3.1 document version to produce.

Methods inherited from interface Prototype.Factory

build

Modifier and Type	Method	Description
OpenApi31Version	build()	Create a new instance of the runtime type from this config object.

Method Details

builder

static OpenApi31VersionConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static OpenApi31VersionConfig.Builder builder(OpenApi31VersionConfig 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 OpenApi31VersionConfig 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 OpenApi31VersionConfig create()

Create a new instance with default values.

Returns:

a new instance

name

String name()

Name of this version configuration.

Returns:

version implementation name

version

String version()

Exact OpenAPI 3.1 document version to produce.

Returns:

OpenAPI document version