Enum Class OpenApi.Style

java.lang.Object

java.lang.Enum<OpenApi.Style>

io.helidon.openapi.OpenApi.Style

All Implemented Interfaces:

Serializable, Comparable<OpenApi.Style>, Constable

Enclosing class:

OpenApi

public static enum OpenApi.Style
extends Enum<OpenApi.Style>

Parameter serialization style.

Declarative OpenAPI generation supports SIMPLE style for path and header parameters, COOKIE style for cookie parameters in OpenAPI 3.2, FORM style for cookie parameters in earlier OpenAPI versions, and FORM, SPACE_DELIMITED, or PIPE_DELIMITED style for query parameters. Delimited query styles require list-valued parameters and cannot use OpenApi.Explode.TRUE. Header parameters cannot use OpenApi.Explode.TRUE. DEEP_OBJECT, MATRIX, and LABEL are not supported by declarative HTTP parameter binding.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COOKIE	Cookie style parameters in OpenAPI 3.2.
DEEP_OBJECT	Deep object style parameters.
FORM	Form style parameters.
LABEL	Label style parameters.
MATRIX	Matrix style parameters.
PIPE_DELIMITED	Pipe-delimited array parameters.
SIMPLE	Simple style parameters.
SPACE_DELIMITED	Space-delimited array parameters.
UNSPECIFIED	Infer style from the parameter location and type.

Method Summary

Modifier and Type	Method	Description
static OpenApi.Style	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OpenApi.Style[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNSPECIFIED

public static final OpenApi.Style UNSPECIFIED

Infer style from the parameter location and type.

MATRIX

public static final OpenApi.Style MATRIX

Matrix style parameters.

LABEL

public static final OpenApi.Style LABEL

Label style parameters.

FORM

public static final OpenApi.Style FORM

Form style parameters.

COOKIE

public static final OpenApi.Style COOKIE

Cookie style parameters in OpenAPI 3.2.

SIMPLE

public static final OpenApi.Style SIMPLE

Simple style parameters.

SPACE_DELIMITED

public static final OpenApi.Style SPACE_DELIMITED

Space-delimited array parameters.

PIPE_DELIMITED

public static final OpenApi.Style PIPE_DELIMITED

Pipe-delimited array parameters.

DEEP_OBJECT

public static final OpenApi.Style DEEP_OBJECT

Deep object style parameters.

Method Details

values

public static OpenApi.Style[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static OpenApi.Style valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null