rocks.xmpp.extensions.data.model

Class DataForm.Field.Builder

java.lang.Object

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

Enclosing class:

DataForm.Field

public static final class DataForm.Field.Builder
extends java.lang.Object

A builder class to build a data form field.

Method Summary

Modifier and Type	Method and Description
DataForm.Field	build() Builds the field.
DataForm.Field.Builder	description(java.lang.String description) Sets the description.
DataForm.Field.Builder	label(java.lang.String label) Sets the label.
DataForm.Field.Builder	media(Media media) Sets the media element.
DataForm.Field.Builder	options(java.util.Collection<DataForm.Option> options) Sets the options.
DataForm.Field.Builder	required(boolean required) Sets if the field is required.
DataForm.Field.Builder	type(DataForm.Field.Type type) Sets the type of the field.
DataForm.Field.Builder	validation(Validation validation) Sets the validation.
DataForm.Field.Builder	value(boolean value) Sets the value as boolean.
DataForm.Field.Builder	value(java.time.Instant instant) Sets the value as date.
DataForm.Field.Builder	value(int value) Sets the value as integer.
DataForm.Field.Builder	value(Jid value) Sets the value as JID.
DataForm.Field.Builder	value(java.lang.String value) Sets the value as string.
DataForm.Field.Builder	values(java.util.Collection<java.lang.String> values) Sets the values.
DataForm.Field.Builder	valuesEnum(java.util.Collection<? extends java.lang.Enum<?>> values) Sets the values from an enum.
DataForm.Field.Builder	valuesJid(java.util.Collection<Jid> values) Sets the values as JIDs.
DataForm.Field.Builder	var(java.lang.String var) Sets the var attribute.

Methods inherited from class java.lang.Object

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

Method Detail

type

public final DataForm.Field.Builder type(DataForm.Field.Type type)

Sets the type of the field.

Parameters:

type - The field type.

Returns:

The builder.

required

public final DataForm.Field.Builder required(boolean required)

Sets if the field is required.

Parameters:

required - If the field is required.

Returns:

The builder.

description

public final DataForm.Field.Builder description(java.lang.String description)

Sets the description.

Parameters:

description - The description.

Returns:

The builder.

media

public final DataForm.Field.Builder media(Media media)

Sets the media element.

Parameters:

media - The media element.

Returns:

The builder.

validation

public final DataForm.Field.Builder validation(Validation validation)

Sets the validation.

Parameters:

validation - The validation.

Returns:

The builder.

label

public final DataForm.Field.Builder label(java.lang.String label)

Sets the label.

Parameters:

label - The label.

Returns:

The builder.

var

public final DataForm.Field.Builder var(java.lang.String var)

Sets the var attribute.

Parameters:

var - The var attribute.

Returns:

The builder.

value

public final DataForm.Field.Builder value(java.lang.String value)

Sets the value as string.

Parameters:

value - The value.

Returns:

The builder.

value

public final DataForm.Field.Builder value(boolean value)

Sets the value as boolean. This methods sets the field type implicitly to DataForm.Field.Type.BOOLEAN.

Parameters:

value - The value.

Returns:

The builder.

value

public final DataForm.Field.Builder value(int value)

Sets the value as integer. This methods sets the field type implicitly to DataForm.Field.Type.TEXT_SINGLE.

Parameters:

value - The value.

Returns:

The builder.

value

public final DataForm.Field.Builder value(Jid value)

Sets the value as JID. This methods sets the field type implicitly to DataForm.Field.Type.JID_SINGLE.

Parameters:

value - The value.

Returns:

The builder.

value

public final DataForm.Field.Builder value(java.time.Instant instant)

Sets the value as date. This methods sets the field type implicitly to DataForm.Field.Type.TEXT_SINGLE.

Parameters:

instant - The value.

Returns:

The builder.

values

public final DataForm.Field.Builder values(java.util.Collection<java.lang.String> values)

Sets the values. This methods sets the field type implicitly to DataForm.Field.Type.TEXT_MULTI.

Parameters:

values - The values.

Returns:

The builder.

valuesEnum

public final DataForm.Field.Builder valuesEnum(java.util.Collection<? extends java.lang.Enum<?>> values)

Sets the values from an enum. This methods sets the field type implicitly to DataForm.Field.Type.LIST_SINGLE.

Parameters:

values - The values.

Returns:

The builder.

valuesJid

public final DataForm.Field.Builder valuesJid(java.util.Collection<Jid> values)

Sets the values as JIDs. This methods sets the field type implicitly to DataForm.Field.Type.JID_MULTI.

Parameters:

values - The values.

Returns:

The builder.

options

public final DataForm.Field.Builder options(java.util.Collection<DataForm.Option> options)

Sets the options.

Parameters:

options - The options.

Returns:

The builder.

build

public final DataForm.Field build()

Builds the field.

Returns:

The field.