org.apache.juneau.httppart

Enum HttpPartSchema.Format

java.lang.Object

java.lang.Enum<HttpPartSchema.Format>

org.apache.juneau.httppart.HttpPartSchema.Format

All Implemented Interfaces:

Serializable, Comparable<HttpPartSchema.Format>

Enclosing class:

HttpPartSchema

public static enum HttpPartSchema.Format
extends Enum<HttpPartSchema.Format>

Valid values for the format field.

Enum Constant Summary

Enum Constants

Enum Constant and 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.
DOUBLE 64-bit floating point number.
FLOAT 32-bit floating point number.
INT32 Signed 32 bits.
INT64 Signed 64 bits.
NO_FORMAT Not specified.
PASSWORD Used to hint UIs the input needs to be obscured.
UON UON notation (e.g.

Method Summary

Modifier and Type	Method and Description
boolean	isOneOf(HttpPartSchema.Format... list) Returns true if this format is in the provided list.
String	toString()
static HttpPartSchema.Format	valueOf(String name) Returns the enum constant of this type with the specified name.
static HttpPartSchema.Format[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INT32

public static final HttpPartSchema.Format INT32

Signed 32 bits.

INT64

public static final HttpPartSchema.Format INT64

Signed 64 bits.

FLOAT

public static final HttpPartSchema.Format FLOAT

32-bit floating point number.

DOUBLE

public static final HttpPartSchema.Format DOUBLE

64-bit floating point number.

BYTE

public static final HttpPartSchema.Format BYTE

BASE-64 encoded characters.

BINARY

public static final HttpPartSchema.Format BINARY

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

BINARY_SPACED

public static final HttpPartSchema.Format BINARY_SPACED

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

DATE

public static final HttpPartSchema.Format DATE

An RFC3339 full-date.

DATE_TIME

public static final HttpPartSchema.Format DATE_TIME

An RFC3339 date-time.

PASSWORD

public static final HttpPartSchema.Format PASSWORD

Used to hint UIs the input needs to be obscured.

UON

public static final HttpPartSchema.Format UON

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

NO_FORMAT

public static final HttpPartSchema.Format NO_FORMAT

Not specified.

Method Detail

values

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

Returns:

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

valueOf

public static HttpPartSchema.Format 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

toString

public String toString()

Overrides:

toString in class Enum<HttpPartSchema.Format>

isOneOf

public boolean isOneOf(HttpPartSchema.Format... 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.