Package org.jivesoftware.smackx.xdata

Class BooleanFormField

java.lang.Object

org.jivesoftware.smackx.xdata.FormField

org.jivesoftware.smackx.xdata.SingleValueFormField

org.jivesoftware.smackx.xdata.BooleanFormField

All Implemented Interfaces:

Element, FullyQualifiedElement, NamedElement, XmlLangElement

public class BooleanFormField
extends SingleValueFormField

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BooleanFormField.Builder

Nested classes/interfaces inherited from class org.jivesoftware.smackx.xdata.FormField

FormField.Description, FormField.Option, FormField.Required, FormField.Type, FormField.Value

Field Summary

Fields inherited from class org.jivesoftware.smackx.xdata.FormField

ELEMENT, extraXmlChildElements, FORM_TYPE, NAMESPACE, QNAME

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BooleanFormField(BooleanFormField.Builder builder)

Method Summary

Modifier and Type	Method	Description
BooleanFormField.Builder	asBuilder()
String	getValue()
boolean	getValueAsBoolean()	Get the value of the booelan field.
Boolean	getValueAsBooleanOrNull()	Get the value of the boolean field or maybe null.

Methods inherited from class org.jivesoftware.smackx.xdata.SingleValueFormField

getRawValue, getRawValues, getValues, populateExtraXmlChildElements

Methods inherited from class org.jivesoftware.smackx.xdata.FormField

asHiddenFormTypeFieldIfPossible, booleanBuilder, builder, buildHiddenFormType, equals, fixedBuilder, fixedBuilder, getDescription, getElementName, getFieldName, getFirstValue, getFirstValueAsDate, getFormFieldChildElement, getFormFieldChildElements, getFormFieldChildElements, getLabel, getNamespace, getQName, getRawValueCharSequences, getType, getValuesAsString, getVariable, hashCode, hasValueSet, hiddenBuilder, ifPossibleAs, ifPossibleAsOrThrow, isRequired, jidMultiBuilder, jidSingleBuilder, listMultiBuilder, listSingleBuilder, textMultiBuilder, textPrivateBuilder, textSingleBuilder, toXML, toXML

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jivesoftware.smack.packet.Element

toXML, toXML

Methods inherited from interface org.jivesoftware.smack.packet.FullyQualifiedElement

getLanguage

Constructor Detail

BooleanFormField

protected BooleanFormField(BooleanFormField.Builder builder)

Method Detail

getValue

public String getValue()

Specified by:

getValue in class SingleValueFormField

getValueAsBoolean

public boolean getValueAsBoolean()

Get the value of the booelan field. Note that, if no explicit boolean value is provided, in the form of "true", "false", "0", or "1", then the default value of a boolean field is false, according to XEP-0004 § 3.3.

Returns:

the boolean value of this form field.

getValueAsBooleanOrNull

public Boolean getValueAsBooleanOrNull()

Get the value of the boolean field or maybe null. Note that you usually want to use getValueAsBoolean() instead of this method, as getValueAsBoolean() considers the default value of boolean fields. That is, boolean form fields have the value false if not explicitly set to something else.

Returns:

the boolean value of this form field or null if no value was explicitly provided.

Since:

4.4.5

See Also:

getValueAsBoolean()

asBuilder

public BooleanFormField.Builder asBuilder()