Enum Class StructuredDataType

java.lang.Object

java.lang.Enum<StructuredDataType>

com.authlete.hms.StructuredDataType

All Implemented Interfaces:

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

public enum StructuredDataType
extends Enum<StructuredDataType>

Structured data types.

Since:

1.1

See Also:

• RFC 8941 Structured Field Values for HTTP, Section 3. Structured Data Types
• IANA Hypertext Transfer Protocol (HTTP) Field Name Registry

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
DICTIONARY	Dictionary.
ITEM	Item.
LIST	List.

Method Summary

Modifier and Type	Method	Description
static StructuredDataType	getByFieldName(String fieldName)	Get the structured data type of the specified field.
static StructuredDataType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static StructuredDataType[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

LIST

public static final StructuredDataType LIST

List.

See Also:

• RFC 8941 Structured Field Values for HTTP, Section 3.1. Lists

DICTIONARY

public static final StructuredDataType DICTIONARY

Dictionary.

See Also:

• RFC 8941 Structured Field Values for HTTP, Section 3.2. Dictionaries

ITEM

public static final StructuredDataType ITEM

Item.

See Also:

• RFC 8941 Structured Field Values for HTTP, Section 3.3. Items

Method Details

values

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

getByFieldName

public static StructuredDataType getByFieldName(String fieldName)

Get the structured data type of the specified field.

Parameters:

fieldName - A field name.

Returns:

The data type of the specified field. If unknown, null is returned.