Interface XmlToken

All Superinterfaces:
XmlAnySimpleType, XmlNormalizedString, XmlObject, XmlString, XmlTokenSource
All Known Subinterfaces:
XmlENTITY, XmlID, XmlIDREF, XmlLanguage, XmlName, XmlNCName, XmlNMTOKEN

public interface XmlToken
extends XmlNormalizedString

Corresponds to the XML Schema xs:token type. One of the derived types based on xs:string.

A token is XML's best representation for a "whitespace insensitive string." All carriage returns, linefeeds, and tabs are converted to ordinary space characters (as with xs:normalizedString), and furthermore, all contiguous runs of space are collapsed to single spaces, and leading and trailing spaces are trimmed.

If you want "  high  priority  " to be equivalent to "high priority", you should consider using xs:token or a subtype of xs:token.

When the XmlAnySimpleType.stringValue() is obtained from an XmlToken, the normalized, trimmed, whitespace collapsed value is returned.

Convertible to String.

Nested Class Summary
static class XmlToken.Factory
          A class with methods for creating instances of XmlToken.
Field Summary
static SchemaType type
          The constant SchemaType object representing this schema type.
Fields inherited from interface org.apache.xmlbeans.XmlObject
Methods inherited from interface org.apache.xmlbeans.XmlAnySimpleType
getStringValue, set, setStringValue, stringValue
Methods inherited from interface org.apache.xmlbeans.XmlObject
changeType, compareTo, compareValue, copy, execQuery, execQuery, isImmutable, isNil, schemaType, selectPath, selectPath, set, setNil, toString, validate, validate, valueEquals, valueHashCode
Methods inherited from interface org.apache.xmlbeans.XmlTokenSource
documentProperties, monitor, newCursor, newDomNode, newDomNode, newInputStream, newInputStream, newReader, newReader, newXMLInputStream, newXMLInputStream, save, save, save, save, save, save, save, save, xmlText, xmlText

Field Detail


public static final SchemaType type
The constant SchemaType object representing this schema type.