org.jivesoftware.smackx.xdatavalidation.packet

Class ValidateElement

java.lang.Object

org.jivesoftware.smackx.xdatavalidation.packet.ValidateElement

All Implemented Interfaces:

org.jivesoftware.smack.packet.Element, org.jivesoftware.smack.packet.NamedElement, org.jivesoftware.smack.packet.XmlElement, org.jivesoftware.smack.packet.XmlLangElement, FormFieldChildElement

Direct Known Subclasses:

ValidateElement.BasicValidateElement, ValidateElement.OpenValidateElement, ValidateElement.RangeValidateElement, ValidateElement.RegexValidateElement

public abstract class ValidateElement
extends java.lang.Object
implements FormFieldChildElement

DataValidation Extension according to XEP-0122: Data Forms Validation. This specification defines a backwards-compatible extension to the XMPP Data Forms protocol that enables applications to specify additional validation guidelines related to a FormField in a DataForm, such as validation of standard XML datatypes, application-specific datatypes, value ranges, and regular expressions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ValidateElement.BasicValidateElement Validation only against the datatype itself.
static class	ValidateElement.ListRange This element indicates for "list-multi", that a minimum and maximum number of options should be selected and/or entered.
static class	ValidateElement.OpenValidateElement For "list-single" or "list-multi", indicates that the user may enter a custom value (matching the datatype constraints) or choose from the predefined values.
static class	ValidateElement.RangeValidateElement Indicate that the value should fall within a certain range.
static class	ValidateElement.RegexValidateElement Indicates that the value should be restricted to a regular expression.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DATATYPE_XS_STRING
static java.lang.String	ELEMENT
static java.lang.String	NAMESPACE
static javax.xml.namespace.QName	QNAME

Method Summary

Modifier and Type	Method and Description
protected abstract void	appendXML(org.jivesoftware.smack.util.XmlStringBuilder buf) Append XML.
abstract void	checkConsistency(FormField.Builder<?,?> formFieldBuilder) Check if this element is consistent according to the business rules in XEP-0122.
protected void	checkListRangeConsistency(FormField.Builder<?,?> formField) The >list-range/< element SHOULD be included only when the <field/> is of type "list-multi" and SHOULD be ignored otherwise.
protected void	checkNonMultiConsistency(FormField.Builder<?,?> formField, java.lang.String method) Check that the field being build is not of type multi (or hidden).
static ValidateElement	from(FormField formField)
java.lang.String	getDatatype() Specifies the data type of any value contained within the FormField element.
java.lang.String	getElementName()
ValidateElement.ListRange	getListRange() Get list range.
java.lang.String	getNamespace()
javax.xml.namespace.QName	getQName()
boolean	mustBeOnlyOfHisKind()
void	setListRange(ValidateElement.ListRange listRange) Set list range.
org.jivesoftware.smack.util.XmlStringBuilder	toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jivesoftware.smackx.xdata.FormFieldChildElement

isExclusiveElement, requiresNoTypeSet, validate

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

getLanguage

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

toXML, toXML

Field Detail

DATATYPE_XS_STRING

public static final java.lang.String DATATYPE_XS_STRING

See Also:

Constant Field Values

ELEMENT

public static final java.lang.String ELEMENT

See Also:

Constant Field Values

NAMESPACE

public static final java.lang.String NAMESPACE

See Also:

Constant Field Values

QNAME

public static final javax.xml.namespace.QName QNAME

Method Detail

getDatatype

public java.lang.String getDatatype()

Specifies the data type of any value contained within the FormField element. It MUST meet one of the following conditions:

• Start with "xs:", and be one of the "built-in" datatypes defined in XML Schema Part 2 [2]
• Start with a prefix registered with the XMPP Registrar [3]
• Start with "x:", and specify a user-defined datatype [4]

Returns:

the datatype

getElementName

public java.lang.String getElementName()

Specified by:

getElementName in interface org.jivesoftware.smack.packet.NamedElement

getNamespace

public java.lang.String getNamespace()

Specified by:

getNamespace in interface org.jivesoftware.smack.packet.XmlElement

getQName

public javax.xml.namespace.QName getQName()

Specified by:

getQName in interface org.jivesoftware.smack.packet.XmlElement

mustBeOnlyOfHisKind

public final boolean mustBeOnlyOfHisKind()

Specified by:

mustBeOnlyOfHisKind in interface FormFieldChildElement

toXML

public org.jivesoftware.smack.util.XmlStringBuilder toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace)

Specified by:

toXML in interface org.jivesoftware.smack.packet.Element

appendXML

protected abstract void appendXML(org.jivesoftware.smack.util.XmlStringBuilder buf)

Append XML.

Parameters:

buf - TODO javadoc me please

setListRange

public void setListRange(ValidateElement.ListRange listRange)

Set list range.

Parameters:

listRange - the listRange to set

getListRange

public ValidateElement.ListRange getListRange()

Get list range.

Returns:

the listRange

checkConsistency

public abstract void checkConsistency(FormField.Builder<?,?> formFieldBuilder)

Check if this element is consistent according to the business rules in XEP-0122.

Specified by:

checkConsistency in interface FormFieldChildElement

Parameters:

formFieldBuilder - the builder used to construct the form field.

from

public static ValidateElement from(FormField formField)

checkListRangeConsistency

protected void checkListRangeConsistency(FormField.Builder<?,?> formField)

The >list-range/< element SHOULD be included only when the <field/> is of type "list-multi" and SHOULD be ignored otherwise.

Parameters:

formField - TODO javadoc me please

checkNonMultiConsistency

protected void checkNonMultiConsistency(FormField.Builder<?,?> formField,
                                        java.lang.String method)

Check that the field being build is not of type multi (or hidden).

Parameters:

formField - TODO javadoc me please

method - TODO javadoc me please