Package org.apache.juneau.httppart

Enum Class HttpPartFormat

java.lang.Object

java.lang.Enum<HttpPartFormat>

org.apache.juneau.httppart.HttpPartFormat

All Implemented Interfaces:

Serializable, Comparable<HttpPartFormat>, Constable

public enum HttpPartFormat
extends Enum<HttpPartFormat>

Valid values for the format field.

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
BINARY	Hexadecimal encoded octets (e.g.
BINARY_SPACED	Spaced-separated hexadecimal encoded octets (e.g.
BYTE	BASE-64 encoded characters.
DATE	An RFC3339 full-date.
DATE_TIME	An RFC3339 date-time.
DATE_TIME_ZONE	Date and time with time zone (RFC 3339).
DOUBLE	64-bit floating point number.
DURATION	Duration (RFC 3339 Appendix A).
EMAIL	Email address (RFC 5321).
FLOAT	32-bit floating point number.
HOSTNAME	Internet host name (RFC 1123).
IDN_EMAIL	Internationalized email address (RFC 6531).
IDN_HOSTNAME	Internationalized host name (RFC 5890).
INT32	Signed 32 bits.
INT64	Signed 64 bits.
IPV4	IPv4 address (RFC 2673).
IPV6	IPv6 address (RFC 4291).
IRI	Internationalized Resource Identifier (RFC 3987).
IRI_REFERENCE	IRI Reference (RFC 3987).
JSON_POINTER	JSON Pointer (RFC 6901).
NO_FORMAT	Not specified.
PASSWORD	Used to hint UIs the input needs to be obscured.
REGEX	Regular expression (ECMA-262).
RELATIVE_JSON_POINTER	Relative JSON Pointer.
TIME	Time (RFC 3339).
UON	UON notation (e.g.
URI	Universal Resource Identifier (RFC 3986).
URI_REFERENCE	URI Reference (RFC 3986).
URI_TEMPLATE	URI Template (RFC 6570).
UUID	Universally Unique Identifier (RFC 4122).

Method Summary

Modifier and Type	Method	Description
static HttpPartFormat	fromString(String value)	Create from lowercase dashed name.
boolean	isOneOf(HttpPartFormat... list)	Returns true if this format is in the provided list.
String	toString()
static HttpPartFormat	valueOf(String name)	Returns the enum constant of this class with the specified name.
static HttpPartFormat[]	values()	Returns an array containing the constants of this enum class, 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

INT32

public static final HttpPartFormat INT32

Signed 32 bits.

INT64

public static final HttpPartFormat INT64

Signed 64 bits.

FLOAT

public static final HttpPartFormat FLOAT

32-bit floating point number.

DOUBLE

public static final HttpPartFormat DOUBLE

64-bit floating point number.

BYTE

public static final HttpPartFormat BYTE

BASE-64 encoded characters.

BINARY

public static final HttpPartFormat BINARY

Hexadecimal encoded octets (e.g. "00FF").

BINARY_SPACED

public static final HttpPartFormat BINARY_SPACED

Spaced-separated hexadecimal encoded octets (e.g. "00 FF").

DATE

public static final HttpPartFormat DATE

An RFC3339 full-date.

DATE_TIME

public static final HttpPartFormat DATE_TIME

An RFC3339 date-time.

PASSWORD

public static final HttpPartFormat PASSWORD

Used to hint UIs the input needs to be obscured.

UON

public static final HttpPartFormat UON

UON notation (e.g. "(foo=bar,baz=@(qux,123))").

EMAIL

public static final HttpPartFormat EMAIL

Email address (RFC 5321).

Since:

9.2.0

IDN_EMAIL

public static final HttpPartFormat IDN_EMAIL

Internationalized email address (RFC 6531).

Since:

9.2.0

HOSTNAME

public static final HttpPartFormat HOSTNAME

Internet host name (RFC 1123).

Since:

9.2.0

IDN_HOSTNAME

public static final HttpPartFormat IDN_HOSTNAME

Internationalized host name (RFC 5890).

Since:

9.2.0

IPV4

public static final HttpPartFormat IPV4

IPv4 address (RFC 2673).

Since:

9.2.0

IPV6

public static final HttpPartFormat IPV6

IPv6 address (RFC 4291).

Since:

9.2.0

URI

public static final HttpPartFormat URI

Universal Resource Identifier (RFC 3986).

Since:

9.2.0

URI_REFERENCE

public static final HttpPartFormat URI_REFERENCE

URI Reference (RFC 3986).

Since:

9.2.0

IRI

public static final HttpPartFormat IRI

Internationalized Resource Identifier (RFC 3987).

Since:

9.2.0

IRI_REFERENCE

public static final HttpPartFormat IRI_REFERENCE

IRI Reference (RFC 3987).

Since:

9.2.0

UUID

public static final HttpPartFormat UUID

Universally Unique Identifier (RFC 4122).

Since:

9.2.0

URI_TEMPLATE

public static final HttpPartFormat URI_TEMPLATE

URI Template (RFC 6570).

Since:

9.2.0

JSON_POINTER

public static final HttpPartFormat JSON_POINTER

JSON Pointer (RFC 6901).

Since:

9.2.0

RELATIVE_JSON_POINTER

public static final HttpPartFormat RELATIVE_JSON_POINTER

Relative JSON Pointer.

Since:

9.2.0

REGEX

public static final HttpPartFormat REGEX

Regular expression (ECMA-262).

Since:

9.2.0

DURATION

public static final HttpPartFormat DURATION

Duration (RFC 3339 Appendix A).

Since:

9.2.0

TIME

public static final HttpPartFormat TIME

Time (RFC 3339).

Since:

9.2.0

DATE_TIME_ZONE

public static final HttpPartFormat DATE_TIME_ZONE

Date and time with time zone (RFC 3339).

Since:

9.2.0

NO_FORMAT

public static final HttpPartFormat NO_FORMAT

Not specified.

Method Details

values

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

fromString

public static HttpPartFormat fromString(String value)

Create from lowercase dashed name.

Parameters:

value - The enum name.

Returns:

The enum.

isOneOf

public boolean isOneOf(HttpPartFormat... list)

Returns true if this format is in the provided list.

Parameters:

list - The list of formats to check against.

Returns:

true if this format is in the provided list.

toString

public String toString()

Overrides:

toString in class Enum<HttpPartFormat>