Package org.apache.juneau.rest.httppart

Enum RestPartType

java.lang.Object

java.lang.Enum<RestPartType>

org.apache.juneau.rest.httppart.RestPartType

All Implemented Interfaces:

Serializable, Comparable<RestPartType>, java.lang.constant.Constable

public enum RestPartType
extends Enum<RestPartType>

Represents the possible parameter types as defined by the Swagger 2.0 specification.

See Also:

• Swagger

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BODY	Request body
FORM_DATA	Form data entry
HEADER	Header value
OTHER	Not a standard Swagger-defined field
PATH	Path variable
QUERY	Query parameter
RESPONSE	Response value
RESPONSE_BODY	Response value
RESPONSE_CODE	Response status value
RESPONSE_HEADER	Response header value

Method Summary

Modifier and Type	Method	Description
boolean	isAny(RestPartType... t)	Returns true if this type is any in the specified list.
String	toString()
static RestPartType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static RestPartType[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PATH

public static final RestPartType PATH

Path variable

HEADER

public static final RestPartType HEADER

Header value

FORM_DATA

public static final RestPartType FORM_DATA

Form data entry

QUERY

public static final RestPartType QUERY

Query parameter

BODY

public static final RestPartType BODY

Request body

RESPONSE

public static final RestPartType RESPONSE

Response value

RESPONSE_BODY

public static final RestPartType RESPONSE_BODY

Response value

RESPONSE_HEADER

public static final RestPartType RESPONSE_HEADER

Response header value

RESPONSE_CODE

public static final RestPartType RESPONSE_CODE

Response status value

OTHER

public static final RestPartType OTHER

Not a standard Swagger-defined field

Method Details

values

public static RestPartType[] values()

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

Returns:

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

valueOf

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

isAny

public boolean isAny(RestPartType... t)

Returns true if this type is any in the specified list.

Parameters:

t - The list to check against.

Returns:

true if this type is any in the specified list.

toString

public String toString()

Overrides:

toString in class Enum<RestPartType>