Class OpenApiDocument.LicenseBuilder

java.lang.Object

io.helidon.openapi.OpenApiDocument.LicenseBuilder

All Implemented Interfaces:

Builder<OpenApiDocument.LicenseBuilder, OpenApiDocument.License>, Supplier<OpenApiDocument.License>

Enclosing class:

OpenApiDocument

public static final class OpenApiDocument.LicenseBuilder
extends Object
implements Builder<OpenApiDocument.LicenseBuilder, OpenApiDocument.License>

OpenAPI license builder.

Method Summary

Modifier and Type	Method	Description
OpenApiDocument.License	build()	Build the instance from this builder.
OpenApiDocument.LicenseBuilder	extension(String name, JsonValue value)	Add an extension.
OpenApiDocument.LicenseBuilder	identifier(String identifier)	Set license identifier.
OpenApiDocument.LicenseBuilder	name(String name)	Set license name.
OpenApiDocument.LicenseBuilder	url(String url)	Set license URL.

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.License	get()
default OpenApiDocument.LicenseBuilder	identity()	Instance of this builder as the correct type.
default OpenApiDocument.LicenseBuilder	update(Consumer<OpenApiDocument.LicenseBuilder> consumer)	Update the builder in a fluent API way.

Method Details

name

public OpenApiDocument.LicenseBuilder name(String name)

Set license name.

Parameters:

name - license name

Returns:

updated builder

identifier

public OpenApiDocument.LicenseBuilder identifier(String identifier)

Set license identifier.

Rendered only for OpenAPI 3.1 and later output. When set together with url(String), this value takes precedence for those versions; the URL remains available for OpenAPI 3.0 output.

Parameters:

identifier - SPDX license identifier

Returns:

updated builder

url

public OpenApiDocument.LicenseBuilder url(String url)

Set license URL.

For OpenAPI 3.1 and later output, this value is ignored when identifier(String) is set.

Parameters:

url - license URL

Returns:

updated builder

extension

public OpenApiDocument.LicenseBuilder 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.License build()

Description copied from interface: Builder

Build the instance from this builder.

Specified by:

build in interface Builder<OpenApiDocument.LicenseBuilder, OpenApiDocument.License>

Returns:

instance of the built type