Package eu.bandm.tools.tdom.runtime

Class NmTokensAttribute

java.lang.Object

eu.bandm.tools.tdom.runtime.TypedNode<TypedExtension>

eu.bandm.tools.tdom.runtime.TypedAttribute<List<String>>

eu.bandm.tools.tdom.runtime.NmTokensAttribute

Direct Known Subclasses:

Element_enumset.Attr_default, IdRefsAttribute

public abstract class NmTokensAttribute
extends TypedAttribute<List<String>>

Implements an Attribute of "NMTOKENS" type, which holds as its value a list of NMTOKEN tokens separated by blanks. See [XML 1.0], "3.3.1 Attribute Types" and production rule [8].

See AttributeValues.checkNmToken(String) and splitValues(String) for details of these definitions.

Nested Class Summary

Nested classes/interfaces inherited from class eu.bandm.tools.tdom.runtime.TypedAttribute

TypedAttribute.__PreAtts, TypedAttribute.SafeValues

Nested classes/interfaces inherited from class eu.bandm.tools.tdom.runtime.TypedNode

TypedNode.ParseListener<E extends TypedElement<?,?>>

Field Summary

Fields inherited from class eu.bandm.tools.tdom.runtime.TypedAttribute

__preAtts, emptyAttributes, mutable, safeValues, specified, value

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	NmTokensAttribute()
protected	NmTokensAttribute(@Opt String value)
protected	NmTokensAttribute(@Opt List<String> value)

Method Summary

Modifier and Type	Method	Description
protected void	checkValue(@Opt List<String> values)	Check routine for the validity of the attributes' intended value.
(package private) final void	decode(DecodingInputStream in, TypedExtension ext)	DOCME
final void	encode(EncodingOutputStream out, TypedExtension ext)	DOCME
protected static List<String>	findSplit(Attributes attrs, NamespaceName name)	DOCME
final @Opt String	getStringValue(@Opt List<String> v)	Returns the textual representation of a possible attribute value (not null), as it would be contained literally in a possible XML text representation.
String	getTypeString()	The definition text for the "type" of the attribute in the original DTD.
protected boolean	mustBeNameToken()	Overridden by subclass.
static @Opt List<String>	splitValues(@Opt String text)	Used from extern as auxiliary method.

Methods inherited from class eu.bandm.tools.tdom.runtime.TypedAttribute

assertSetAttrValid, assertSetAttrValid, checkRequired, clearValue, find, find, getDefaultValue, getLocalName, getNamespaceName, getNamespaceURI, getStringValue, getTagName, getValue, isFixed, isOptional, isRequired, isSpecified, makeUnspecified, put, setValue

Methods inherited from class eu.bandm.tools.tdom.runtime.TypedNode

asBigDecimal, asBigDecimal, asBigDecimal, asBigDecimal, asBigInteger, asBigInteger, asBigInteger, asBigInteger, asBoolean, asBoolean, asDouble, asDouble, asDouble, asDouble, asFloat, asFloat, asFloat, asFloat, asHexInt, asHexInt, asHexInt, asHexInt, asInt, asInt, asInt, asInt, asLong, asLong, asLong, asLong, asTrimmedString, asTrimmedString, asTrimmedString, asTrimmedString, checkPlus, checkPlus, checkStar, checkStar, checkStrict, encode, encodeOptional, encodePlus, encodePlus, encodeStar, encodeStar, extractEthereals, getLocation, getPCData, setLocation, setLocation, setLocation

Methods inherited from class java.lang.Object

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

Constructor Details

NmTokensAttribute

protected NmTokensAttribute()

NmTokensAttribute

protected NmTokensAttribute(@Opt
 @Opt List<String> value)
                     throws TdomAttributeSyntaxException

Throws:

TdomAttributeSyntaxException

NmTokensAttribute

protected NmTokensAttribute(@Opt
 @Opt String value)
                     throws TdomAttributeSyntaxException

Throws:

TdomAttributeSyntaxException

Method Details

checkValue

protected void checkValue(@Opt
 @Opt List<String> values)
                   throws TdomAttributeSyntaxException

Check routine for the validity of the attributes' intended value. Is a call-back, implemented by the sub-classes. Is called only here, by two constructors and the TypedAttribute.setValue(V) method. The value null means "absent" for #IMPLIED attributes and passes the test.

Specified by:

checkValue in class TypedAttribute<List<String>>

Parameters:

values - the value to test; maybe null.

Throws:

TdomAttributeSyntaxException - iff the value does not match the type of the XML attribute, including a forbidden Null.

getTypeString

public String getTypeString()

The definition text for the "type" of the attribute in the original DTD.

Specified by:

getTypeString in class TypedAttribute<List<String>>

mustBeNameToken

protected boolean mustBeNameToken()

Overridden by subclass.

Returns:

whether the stronger rule for Name (not NmToken) must be applied.

splitValues

@Opt
public static @Opt List<String> splitValues(@Opt
 @Opt String text)

Used from extern as auxiliary method. The definition [XML 1.0] production rule [8] requires exactly one space (= character 0x20) between tokens, and tokens must be at least one character long. But this method accepts space, tab, newline, and return as separator.

FIXME the current impl gives strange diagnosis for multiple adjacent separators, as in att="b⎵⎵⎵c".

encode

public final void encode(EncodingOutputStream out,
 TypedExtension ext)
                  throws IOException

DOCME

Specified by:

encode in class TypedNode<TypedExtension>

Throws:

IOException

decode

final void decode(DecodingInputStream in,
 TypedExtension ext)
           throws IOException,
TdomAttributeSyntaxException

DOCME

Specified by:

decode in class TypedAttribute<List<String>>

Throws:

IOException

TdomAttributeSyntaxException

findSplit

protected static List<String> findSplit(Attributes attrs,
 NamespaceName name)

DOCME

getStringValue

@Opt
public final @Opt String getStringValue(@Opt
 @Opt List<String> v)

Returns the textual representation of a possible attribute value (not null), as it would be contained literally in a possible XML text representation. Since the textual representation of a String is the string itself, this method is relevant for enumeration types only (Later: also for "entity" types, but these are not yet supported.)

Specified by:

getStringValue in class TypedAttribute<List<String>>

Returns:

(never null) the textual representation of this attribute value, as it would be contained literally in a possible XML text representation.