Class OpenApiDocument.InfoBuilder

java.lang.Object

io.helidon.openapi.OpenApiDocument.InfoBuilder

All Implemented Interfaces:

Builder<OpenApiDocument.InfoBuilder, OpenApiDocument.Info>, Supplier<OpenApiDocument.Info>

Enclosing class:

OpenApiDocument

public static final class OpenApiDocument.InfoBuilder
extends Object
implements Builder<OpenApiDocument.InfoBuilder, OpenApiDocument.Info>

OpenAPI info builder.

Method Summary

Modifier and Type	Method	Description
OpenApiDocument.Info	build()	Build the instance from this builder.
OpenApiDocument.InfoBuilder	contact(OpenApiDocument.Contact contact)	Set contact.
OpenApiDocument.InfoBuilder	contact(Consumer<OpenApiDocument.ContactBuilder> contact)	Set contact.
OpenApiDocument.InfoBuilder	description(String description)	Set description.
OpenApiDocument.InfoBuilder	extension(String name, JsonValue value)	Add an extension.
OpenApiDocument.InfoBuilder	license(OpenApiDocument.License license)	Set license.
OpenApiDocument.InfoBuilder	license(Consumer<OpenApiDocument.LicenseBuilder> license)	Set license.
OpenApiDocument.InfoBuilder	summary(String summary)	Set summary.
OpenApiDocument.InfoBuilder	termsOfService(String termsOfService)	Set terms of service.
OpenApiDocument.InfoBuilder	title(String title)	Set title.
OpenApiDocument.InfoBuilder	version(String version)	Set version.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Builder

get, identity, update

Modifier and Type	Method	Description
default OpenApiDocument.Info	get()
default OpenApiDocument.InfoBuilder	identity()	Instance of this builder as the correct type.
default OpenApiDocument.InfoBuilder	update(Consumer<OpenApiDocument.InfoBuilder> consumer)	Update the builder in a fluent API way.

Method Details

title

public OpenApiDocument.InfoBuilder title(String title)

Set title.

Parameters:

title - title

Returns:

updated builder

version

public OpenApiDocument.InfoBuilder version(String version)

Set version.

Parameters:

version - version

Returns:

updated builder

summary

public OpenApiDocument.InfoBuilder summary(String summary)

Set summary.

Parameters:

summary - summary

Returns:

updated builder

description

public OpenApiDocument.InfoBuilder description(String description)

Set description.

Parameters:

description - description

Returns:

updated builder

termsOfService

public OpenApiDocument.InfoBuilder termsOfService(String termsOfService)

Set terms of service.

Parameters:

termsOfService - terms of service

Returns:

updated builder

contact

public OpenApiDocument.InfoBuilder contact(OpenApiDocument.Contact contact)

Set contact.

Parameters:

contact - contact

Returns:

updated builder

contact

public OpenApiDocument.InfoBuilder contact(Consumer<OpenApiDocument.ContactBuilder> contact)

Set contact.

Parameters:

contact - consumer to update contact builder

Returns:

updated builder

license

public OpenApiDocument.InfoBuilder license(OpenApiDocument.License license)

Set license.

Parameters:

license - license

Returns:

updated builder

license

public OpenApiDocument.InfoBuilder license(Consumer<OpenApiDocument.LicenseBuilder> license)

Set license.

Parameters:

license - consumer to update license builder

Returns:

updated builder

extension

public OpenApiDocument.InfoBuilder extension(String name,
 JsonValue value)

Add an extension.

Extension names must start with x-.

Parameters:

name - extension name

value - extension value

Returns:

updated builder

build

public OpenApiDocument.Info build()

Description copied from interface: Builder

Build the instance from this builder.

Specified by:

build in interface Builder<OpenApiDocument.InfoBuilder, OpenApiDocument.Info>

Returns:

instance of the built type