rocks.xmpp.extensions.data.model

Class DataForm.Field

java.lang.Object

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

All Implemented Interfaces:

Comparable<DataForm.Field>

Enclosing class:

DataForm

public static final class DataForm.Field
extends Object
implements Comparable<DataForm.Field>

A form field.

See Also:

3.2 The Field Element

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataForm.Field.Builder A builder class to build a data form field.
static class	DataForm.Field.Type Defines field types.

Constructor Summary

Constructors

Constructor and Description
Field(DataForm.Field.Type type) Deprecated. Use DataForm.Field.Builder.
Field(DataForm.Field.Type type, String var, String... values) Deprecated. Use DataForm.Field.Builder.

Method Summary

Modifier and Type	Method and Description
static DataForm.Field.Builder	builder() Creates the builder to build a data form field.
int	compareTo(DataForm.Field o)
String	getDescription() Gets a natural-language description of the field, intended for presentation in a user-agent (e.g., as a "tool-tip", help button, or explanatory text provided near the field).
String	getLabel() Gets the field label.
Media	getMedia() Gets the media element.
List<DataForm.Option>	getOptions() Gets the options if the field type is DataForm.Field.Type.LIST_SINGLE or DataForm.Field.Type.LIST_MULTI.
DataForm.Field.Type	getType() Gets the field type.
Validation	getValidation() Gets the validation for this field.
boolean	getValueAsBoolean() Gets the value as boolean.
Date	getValueAsDate() Returns the first value as date.
Integer	getValueAsInteger() Returns the first value as integer.
Jid	getValueAsJid() Returns the first value as JID, e.g. for the DataForm.Field.Type.JID_SINGLE field type.
List<String>	getValues() Gets the values of the field.
List<Jid>	getValuesAsJid() Returns a JID list for the DataForm.Field.Type.JID_MULTI field type.
String	getVar() Gets a unique identifier for the field in the context of the form.
boolean	isRequired() If the field as required in order for the form to be considered valid.
void	setDescription(String description) Deprecated. Use DataForm.Field.Builder.
void	setLabel(String label) Deprecated. Use DataForm.Field.Builder.
void	setMedia(Media media) Deprecated. Use DataForm.Field.Builder.
void	setRequired(boolean required) Deprecated. Use DataForm.Field.Builder.
void	setType(DataForm.Field.Type type) Deprecated. Use DataForm.Field.Builder.
void	setValidation(Validation validation) Deprecated. Use DataForm.Field.Builder.
void	setVar(String var) Deprecated. Use DataForm.Field.Builder.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Field

@Deprecated
public Field(DataForm.Field.Type type)

Deprecated. Use DataForm.Field.Builder.

Creates a field.

Parameters:

type - The field type.

Field

public Field(DataForm.Field.Type type,
             String var,
             String... values)

Deprecated. Use DataForm.Field.Builder.

Creates a field.

Parameters:

type - The field type.

var - The unique identifier for the field.

values - The values.

Method Detail

builder

public static DataForm.Field.Builder builder()

Creates the builder to build a data form field.

Returns:

The builder.

getType

public DataForm.Field.Type getType()

Gets the field type.

Returns:

The field type.

setType

@Deprecated
public void setType(DataForm.Field.Type type)

Deprecated. Use DataForm.Field.Builder.

Sets the field type.

Parameters:

type - The type.

getVar

public String getVar()

Gets a unique identifier for the field in the context of the form.

Returns:

The var attribute.

See Also:

setVar(String)

setVar

@Deprecated
public void setVar(String var)

Deprecated. Use DataForm.Field.Builder.

Sets a unique identifier for the field in the context of the form.

Parameters:

var - The var attribute.

See Also:

getVar()

getLabel

public String getLabel()

Gets the field label.

Returns:

The label.

See Also:

setLabel(String)

setLabel

@Deprecated
public void setLabel(String label)

Deprecated. Use DataForm.Field.Builder.

Sets the field label.

Parameters:

label - The label.

See Also:

getLabel()

getOptions

public List<DataForm.Option> getOptions()

Gets the options if the field type is DataForm.Field.Type.LIST_SINGLE or DataForm.Field.Type.LIST_MULTI.

Returns:

The options.

getValues

public List<String> getValues()

Gets the values of the field. Fields of type DataForm.Field.Type.LIST_MULTI, DataForm.Field.Type.JID_MULTI or DataForm.Field.Type.TEXT_MULTI may contain multiple values.

Returns:

The values.

getValueAsBoolean

public boolean getValueAsBoolean()

Gets the value as boolean.

Returns:

The value as boolean.

getValueAsInteger

public Integer getValueAsInteger()

Returns the first value as integer.

Returns:

The integer or null, if the values are empty.

getValueAsDate

public Date getValueAsDate()

Returns the first value as date.

Returns:

The date or null, if the values are empty.

getValuesAsJid

public List<Jid> getValuesAsJid()

Returns a JID list for the DataForm.Field.Type.JID_MULTI field type.

Returns:

The JID list.

getValueAsJid

public Jid getValueAsJid()

Returns the first value as JID, e.g. for the DataForm.Field.Type.JID_SINGLE field type.

Returns:

The JID or null, if the values are empty.

getMedia

public Media getMedia()

Gets the media element.

Returns:

The media element.

setMedia

@Deprecated
public void setMedia(Media media)

Deprecated. Use DataForm.Field.Builder.

Sets a media element.

Parameters:

media - The media element.

See Also:

getMedia()

getDescription

public String getDescription()

Gets a natural-language description of the field, intended for presentation in a user-agent (e.g., as a "tool-tip", help button, or explanatory text provided near the field).

Returns:

The description.

setDescription

@Deprecated
public void setDescription(String description)

Deprecated. Use DataForm.Field.Builder.

Sets a description of the field.

Parameters:

description - The description.

See Also:

getDescription()

getValidation

public Validation getValidation()

Gets the validation for this field.

Returns:

The validation.

See Also:

XEP-0122: Data Forms Validation

setValidation

@Deprecated
public void setValidation(Validation validation)

Deprecated. Use DataForm.Field.Builder.

Sets the validation for this field.

Parameters:

validation - The validation.

See Also:

XEP-0122: Data Forms Validation

isRequired

public boolean isRequired()

If the field as required in order for the form to be considered valid.

Returns:

True, if the field is required.

setRequired

@Deprecated
public void setRequired(boolean required)

Deprecated. Use DataForm.Field.Builder.

Sets the field as required.

Parameters:

required - If the field is required.

See Also:

isRequired()

compareTo

public int compareTo(DataForm.Field o)

Specified by:

compareTo in interface Comparable<DataForm.Field>