Package rocks.xmpp.extensions.data.model

Enum DataForm.Field.Type

java.lang.Object

java.lang.Enum<DataForm.Field.Type>

rocks.xmpp.extensions.data.model.DataForm.Field.Type

All Implemented Interfaces:

Serializable, Comparable<DataForm.Field.Type>

Enclosing class:

DataForm.Field

public static enum DataForm.Field.Type
extends Enum<DataForm.Field.Type>

Defines field types.

3.3 Field Types

The following field types represent data "types" that are commonly exchanged between Jabber/XMPP entities.

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOOLEAN	The field enables an entity to gather or provide an either-or choice between two options.
FIXED	The field is intended for data description (e.g., human-readable text such as "section" headers) rather than data gathering or provision.
HIDDEN	The field is not shown to the form-submitting entity, but instead is returned with the form.
JID_MULTI	The field enables an entity to gather or provide multiple Jabber IDs.
JID_SINGLE	The field enables an entity to gather or provide a single Jabber ID.
LIST_MULTI	The field enables an entity to gather or provide one or more options from among many.
LIST_SINGLE	The field enables an entity to gather or provide one option from among many.
TEXT_MULTI	The field enables an entity to gather or provide multiple lines of text.
TEXT_PRIVATE	The field enables an entity to gather or provide a single line or word of text, which shall be obscured in an interface (e.g., with multiple instances of the asterisk character).
TEXT_SINGLE	The field enables an entity to gather or provide a single line or word of text, which may be shown in an interface.

Method Summary

Modifier and Type	Method	Description
static DataForm.Field.Type	valueOf(String name)	Returns the enum constant of this type with the specified name.
static DataForm.Field.Type[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BOOLEAN

public static final DataForm.Field.Type BOOLEAN

The field enables an entity to gather or provide an either-or choice between two options. The default value is "false".

FIXED

public static final DataForm.Field.Type FIXED

The field is intended for data description (e.g., human-readable text such as "section" headers) rather than data gathering or provision. The <value/> child SHOULD NOT contain newlines (the \n and \r characters); instead an application SHOULD generate multiple fixed fields, each with one <value/> child.

HIDDEN

public static final DataForm.Field.Type HIDDEN

The field is not shown to the form-submitting entity, but instead is returned with the form. The form-submitting entity SHOULD NOT modify the value of a hidden field, but MAY do so if such behavior is defined for the "using protocol".

JID_MULTI

public static final DataForm.Field.Type JID_MULTI

The field enables an entity to gather or provide multiple Jabber IDs. Each provided JID SHOULD be unique (as determined by comparison that includes application of the Nodeprep, Nameprep, and Resourceprep profiles of Stringprep as specified in XMPP Core), and duplicate JIDs MUST be ignored.

JID_SINGLE

public static final DataForm.Field.Type JID_SINGLE

The field enables an entity to gather or provide a single Jabber ID.

LIST_MULTI

public static final DataForm.Field.Type LIST_MULTI

The field enables an entity to gather or provide one or more options from among many. A form-submitting entity chooses one or more items from among the options presented by the form-processing entity and MUST NOT insert new options. The form-submitting entity MUST NOT modify the order of items as received from the form-processing entity, since the order of items MAY be significant.

LIST_SINGLE

public static final DataForm.Field.Type LIST_SINGLE

The field enables an entity to gather or provide one option from among many. A form-submitting entity chooses one item from among the options presented by the form-processing entity and MUST NOT insert new options.

TEXT_MULTI

public static final DataForm.Field.Type TEXT_MULTI

The field enables an entity to gather or provide multiple lines of text.

TEXT_PRIVATE

public static final DataForm.Field.Type TEXT_PRIVATE

The field enables an entity to gather or provide a single line or word of text, which shall be obscured in an interface (e.g., with multiple instances of the asterisk character).

TEXT_SINGLE

public static final DataForm.Field.Type TEXT_SINGLE

The field enables an entity to gather or provide a single line or word of text, which may be shown in an interface. This field type is the default and MUST be assumed if a form-submitting entity receives a field type it does not understand.

Method Detail

values

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

Returns:

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

valueOf

public static DataForm.Field.Type 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