com.linecorp.armeria.server.docs

Enum FieldLocation

java.lang.Object

java.lang.Enum<FieldLocation>

com.linecorp.armeria.server.docs.FieldLocation

All Implemented Interfaces:

Serializable, Comparable<FieldLocation>

@UnstableApi
public enum FieldLocation
extends Enum<FieldLocation>

The location of a field.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BODY The field is located in the request body.
HEADER The field is located in the header.
PATH The field is located in the path.
QUERY The field is located in the query.
UNSPECIFIED The location of the field is unspecified.

Method Summary

Modifier and Type	Method and Description
static FieldLocation	valueOf(String name) Returns the enum constant of this type with the specified name.
static FieldLocation[]	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

PATH

public static final FieldLocation PATH

The field is located in the path.

HEADER

public static final FieldLocation HEADER

The field is located in the header.

QUERY

public static final FieldLocation QUERY

The field is located in the query.

BODY

public static final FieldLocation BODY

The field is located in the request body.

UNSPECIFIED

public static final FieldLocation UNSPECIFIED

The location of the field is unspecified.

Method Detail

values

public static FieldLocation[] 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 (FieldLocation c : FieldLocation.values())
    System.out.println(c);

Returns:

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

valueOf

public static FieldLocation 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