Package org.apache.juneau.httppart

Enum HttpPartType

java.lang.Object

java.lang.Enum<HttpPartType>

org.apache.juneau.httppart.HttpPartType

All Implemented Interfaces:

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

public enum HttpPartType
extends Enum<HttpPartType>

Represents possible enum values that can be passed to the HttpPartSerializerSession.serialize(HttpPartType, HttpPartSchema, Object).

See Also:

• HTTP Part Serializers and Parsers

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
ANY	Generic part
BODY	An HTTP request body
FORMDATA	A form-data parameter
HEADER	An HTTP request header
OTHER	A non-standard field
PATH	A URI path variable
QUERY	A URI query parameter
RESPONSE_BODY	An HTTP response body
RESPONSE_HEADER	An HTTP response header
RESPONSE_STATUS	An HTTP response status code

Method Summary

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BODY

public static final HttpPartType BODY

An HTTP request body

PATH

public static final HttpPartType PATH

A URI path variable

QUERY

public static final HttpPartType QUERY

A URI query parameter

FORMDATA

public static final HttpPartType FORMDATA

A form-data parameter

HEADER

public static final HttpPartType HEADER

An HTTP request header

RESPONSE_HEADER

public static final HttpPartType RESPONSE_HEADER

An HTTP response header

RESPONSE_BODY

public static final HttpPartType RESPONSE_BODY

An HTTP response body

RESPONSE_STATUS

public static final HttpPartType RESPONSE_STATUS

An HTTP response status code

ANY

public static final HttpPartType ANY

Generic part

OTHER

public static final HttpPartType OTHER

A non-standard field

Method Details

values

public static HttpPartType[] 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 HttpPartType 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