Class OpenApiDocument.EncodingBuilder

java.lang.Object

io.helidon.openapi.OpenApiDocument.EncodingBuilder

All Implemented Interfaces:

Builder<OpenApiDocument.EncodingBuilder, OpenApiDocument.Encoding>, Supplier<OpenApiDocument.Encoding>

Enclosing class:

OpenApiDocument

public static final class OpenApiDocument.EncodingBuilder
extends Object
implements Builder<OpenApiDocument.EncodingBuilder, OpenApiDocument.Encoding>

OpenAPI encoding builder.

Method Summary

Modifier and Type	Method	Description
OpenApiDocument.EncodingBuilder	allowReserved(boolean allowReserved)	Set allow reserved flag.
OpenApiDocument.Encoding	build()	Build the instance from this builder.
OpenApiDocument.EncodingBuilder	contentType(String contentType)	Set content type.
OpenApiDocument.EncodingBuilder	encoding(String name, OpenApiDocument.Encoding encoding)	Add nested OpenAPI 3.2 encoding.
OpenApiDocument.EncodingBuilder	explode(boolean explode)	Set explode flag.
OpenApiDocument.EncodingBuilder	extension(String name, JsonValue value)	Add an extension.
OpenApiDocument.EncodingBuilder	header(String name, OpenApiDocument.Header header)	Add header.
OpenApiDocument.EncodingBuilder	itemEncoding(OpenApiDocument.Encoding itemEncoding)	Set OpenAPI 3.2 item encoding.
OpenApiDocument.EncodingBuilder	prefixEncoding(JsonArray prefixEncoding)	Set OpenAPI 3.2 prefix encodings.
OpenApiDocument.EncodingBuilder	style(String style)	Set style.

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

Method Details

contentType

public OpenApiDocument.EncodingBuilder contentType(String contentType)

Set content type.

Parameters:

contentType - content type

Returns:

updated builder

header

public OpenApiDocument.EncodingBuilder header(String name,
 OpenApiDocument.Header header)

Add header.

Parameters:

name - header name

header - header

Returns:

updated builder

encoding

public OpenApiDocument.EncodingBuilder encoding(String name,
 OpenApiDocument.Encoding encoding)

Add nested OpenAPI 3.2 encoding.

Parameters:

name - encoding name

encoding - encoding

Returns:

updated builder

prefixEncoding

public OpenApiDocument.EncodingBuilder prefixEncoding(JsonArray prefixEncoding)

Set OpenAPI 3.2 prefix encodings.

Parameters:

prefixEncoding - prefix encodings

Returns:

updated builder

itemEncoding

public OpenApiDocument.EncodingBuilder itemEncoding(OpenApiDocument.Encoding itemEncoding)

Set OpenAPI 3.2 item encoding.

Parameters:

itemEncoding - item encoding

Returns:

updated builder

style

public OpenApiDocument.EncodingBuilder style(String style)

Set style.

Parameters:

style - style

Returns:

updated builder

explode

public OpenApiDocument.EncodingBuilder explode(boolean explode)

Set explode flag.

Parameters:

explode - explode flag

Returns:

updated builder

allowReserved

public OpenApiDocument.EncodingBuilder allowReserved(boolean allowReserved)

Set allow reserved flag.

Parameters:

allowReserved - allow reserved flag

Returns:

updated builder

extension

public OpenApiDocument.EncodingBuilder 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.Encoding build()

Description copied from interface: Builder

Build the instance from this builder.

Specified by:

build in interface Builder<OpenApiDocument.EncodingBuilder, OpenApiDocument.Encoding>

Returns:

instance of the built type