org.openapitools.codegen.languages

Enum AbstractTypeScriptClientCodegen.ParameterExpander.Location

java.lang.Object

java.lang.Enum<AbstractTypeScriptClientCodegen.ParameterExpander.Location>

org.openapitools.codegen.languages.AbstractTypeScriptClientCodegen.ParameterExpander.Location

All Implemented Interfaces:

Serializable, Comparable<AbstractTypeScriptClientCodegen.ParameterExpander.Location>

Enclosing class:

AbstractTypeScriptClientCodegen.ParameterExpander

public static enum AbstractTypeScriptClientCodegen.ParameterExpander.Location
extends Enum<AbstractTypeScriptClientCodegen.ParameterExpander.Location>

Where the parameter is located in the request.

See e.g. OpenAPI 3.1 spec: Parameter Locations

Enum Constant Summary

Enum Constants

Enum Constant and Description
cookie
header
path
query

Field Summary

Fields

Modifier and Type	Field and Description
AbstractTypeScriptClientCodegen.ParameterExpander.ParamStyle	defaultStyle
BiPredicate<CodegenOperation,CodegenParameter>	isPresentIn

Method Summary

Modifier and Type	Method and Description
String	defaultStyle(@Nullable String style)
static AbstractTypeScriptClientCodegen.ParameterExpander.Location	fromParam(CodegenOperation op, CodegenParameter param)
static AbstractTypeScriptClientCodegen.ParameterExpander.Location	valueOf(String name) Returns the enum constant of this type with the specified name.
static AbstractTypeScriptClientCodegen.ParameterExpander.Location[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

query

public static final AbstractTypeScriptClientCodegen.ParameterExpander.Location query

header

public static final AbstractTypeScriptClientCodegen.ParameterExpander.Location header

path

public static final AbstractTypeScriptClientCodegen.ParameterExpander.Location path

cookie

public static final AbstractTypeScriptClientCodegen.ParameterExpander.Location cookie

Field Detail

defaultStyle

public final AbstractTypeScriptClientCodegen.ParameterExpander.ParamStyle defaultStyle

isPresentIn

public final BiPredicate<CodegenOperation,CodegenParameter> isPresentIn

Method Detail

values

public static AbstractTypeScriptClientCodegen.ParameterExpander.Location[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AbstractTypeScriptClientCodegen.ParameterExpander.Location c : AbstractTypeScriptClientCodegen.ParameterExpander.Location.values())
    System.out.println(c);

Returns:

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

valueOf

public static AbstractTypeScriptClientCodegen.ParameterExpander.Location valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

defaultStyle

public String defaultStyle(@Nullable String style)

fromParam

public static AbstractTypeScriptClientCodegen.ParameterExpander.Location fromParam(CodegenOperation op,
                                                                                   CodegenParameter param)