Package eu.bandm.tools.option.absy

Class Element_optarg.Attr_option

java.lang.Object

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

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

eu.bandm.tools.tdom.runtime.NmTokenAttribute

eu.bandm.tools.option.absy.Element_optarg.Attr_option

All Implemented Interfaces:

Matchable<Matcher>, Visitable<Visitor>

Enclosing class:

Element_optarg

@Undocumented
public static class Element_optarg.Attr_option
extends NmTokenAttribute
implements Visitable<Visitor>, Matchable<Matcher>

Meaning: The option from which the current argument value is taken. It is identified either by its long name or its short abbrev value.

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

Modifier and Type	Field	Description
(package private) static final String	defaultValue
static final NamespaceName	namespaceName	Name of the attribute, as defined in the DTD plus tdom PI namespace declarations.
static final Element_optarg.Attr_option	unspecified

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

__preAtts, emptyAttributes, mutable, safeValues, specified, value

Constructor Summary

Constructors

Constructor	Description
Attr_option()
Attr_option(String value)

Method Summary

Modifier and Type	Method	Description
void	checkRequired()	The overriding method throws the exception if this attribute is required but missing when initializing the tdom instance.
static Element_optarg.Attr_option	from(Element dom)	Create a new instance, its value picked from the W3C DOM instance.
static Element_optarg.Attr_option	from(Attributes attrs)	Create a new instance, its value picked from the SAX attribute container.
final String	getDefaultValue()	Method to read the contents of field defaultValue.
static TypedDTD.AttributeInfo	getInterfaceInfo()
final NamespaceName	getNamespaceName()	Method to read the contents of field namespaceName.
void	host(Visitor visitor)	Send the visitor to this instance.
void	identify(Matcher matcher)
final boolean	isFixed()	Returns whether the attribute is declared as "#FIXED" in the DTD.
final boolean	isOptional()	Returns whether the attribute is declared as "#IMPLIED" in the DTD.

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

_checkToken, checkNameToken, checkNCName, checkNmToken, checkPITarget, checkValue, encode, getStringValue, getTypeString

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

assertSetAttrValid, assertSetAttrValid, clearValue, find, find, getLocalName, getNamespaceURI, getStringValue, getTagName, getValue, 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

Field Details

namespaceName

@Undocumented
public static final NamespaceName namespaceName

Name of the attribute, as defined in the DTD plus tdom PI namespace declarations.

defaultValue

static final String defaultValue

unspecified

public static final Element_optarg.Attr_option unspecified

Constructor Details

Attr_option

Attr_option()

Attr_option

Attr_option(String value)
     throws TdomAttributeSyntaxException

Throws:

TdomAttributeSyntaxException

Method Details

host

public void host(Visitor visitor)

Description copied from interface: Visitable

Send the visitor to this instance.

Specified by:

host in interface Visitable<Visitor>

identify

public void identify(Matcher matcher)

Specified by:

identify in interface Matchable<Matcher>

getNamespaceName

public final NamespaceName getNamespaceName()

Method to read the contents of field namespaceName. @see #namespaceName

Specified by:

getNamespaceName in class TypedAttribute<String>

Returns:

the namespace name of the XML attribute.

checkRequired

public void checkRequired()
                   throws TdomAttributeMissingException

Description copied from class: TypedAttribute

The overriding method throws the exception if this attribute is required but missing when initializing the tdom instance.

Specified by:

checkRequired in class TypedAttribute<String>

Throws:

TdomAttributeMissingException

from

@Undocumented
public static Element_optarg.Attr_option from(Element dom)
                                       throws TdomAttributeSyntaxException

Create a new instance, its value picked from the W3C DOM instance. (If no value is specified, take the default value from the DTD.)

Throws:

TdomAttributeSyntaxException

from

@Undocumented
public static Element_optarg.Attr_option from(Attributes attrs)
                                       throws TdomAttributeSyntaxException

Create a new instance, its value picked from the SAX attribute container. (If no value is specified, take the default value from the DTD.)

Throws:

TdomAttributeSyntaxException

isOptional

public final boolean isOptional()

Description copied from class: TypedAttribute

Returns whether the attribute is declared as "#IMPLIED" in the DTD. Will be overridden by the generated code.

Specified by:

isOptional in class TypedAttribute<String>

Returns:

whether the attribute is declared as "#IMPLIED" in the DTD.

isFixed

public final boolean isFixed()

Description copied from class: TypedAttribute

Returns whether the attribute is declared as "#FIXED" in the DTD. Will be overridden by the generated code.

Specified by:

isFixed in class TypedAttribute<String>

Returns:

whether the attribute is declared as "#FIXED" in the DTD.

getDefaultValue

public final String getDefaultValue()

Method to read the contents of field defaultValue. @see #defaultValue

Specified by:

getDefaultValue in class TypedAttribute<String>

Returns:

the default value defined in the DTD.

getInterfaceInfo

public static TypedDTD.AttributeInfo getInterfaceInfo()