Package eu.bandm.tools.option.absy

Class Element_option.Attr_required

java.lang.Object

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

eu.bandm.tools.tdom.runtime.TypedAttribute<Element_option.Attr_required.Value>

eu.bandm.tools.tdom.runtime.EnumerationAttribute<Element_option.Attr_required.Value>

eu.bandm.tools.option.absy.Element_option.Attr_required

All Implemented Interfaces:

Matchable<Matcher>, Visitable<Visitor>

Enclosing class:

Element_option

@Undocumented
public static class Element_option.Attr_required
extends EnumerationAttribute<Element_option.Attr_required.Value>
implements Visitable<Visitor>, Matchable<Matcher>

Meaning: Says whether this option must be present on the command line. Is used to synthesize checking code.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Element_option.Attr_required.Value

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 Element_option.Attr_required.Value	defaultValue
static final NamespaceName	namespaceName	Name of the attribute, as defined in the DTD plus tdom PI namespace declarations.
static final Element_option.Attr_required	unspecified

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

__preAtts, emptyAttributes, mutable, safeValues, specified, value

Constructor Summary

Constructors

Constructor	Description
Attr_required()
Attr_required(Element_option.Attr_required.Value value)
Attr_required(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_option.Attr_required	from(Element dom)	Create a new instance, its value picked from the W3C DOM instance.
static Element_option.Attr_required	from(Attributes attrs)	Create a new instance, its value picked from the SAX attribute container.
final Element_option.Attr_required.Value	getDefaultValue()	Method to read the contents of field defaultValue.
static TypedDTD.AttributeInfo	getInterfaceInfo()
final NamespaceName	getNamespaceName()	Method to read the contents of field namespaceName.
protected final Class<Element_option.Attr_required.Value>	getValueClass()	Will be overridden in the generated code by a method which returns the dedicated value class.
protected final HashMap<String,? extends Element_option.Attr_required.Value>	getValueMap()	Returns a map from the external representations as appearing in the DTD to the enumeration items of the value's type.
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.
void	setValue(Element_option.Attr_required.Value v)	Set the value of this attribute.

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

checkValue, encode, find, getStringValue, getTypeString, setValue, setValue

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

assertSetAttrValid, assertSetAttrValid, clearValue, find, find, getLocalName, getNamespaceURI, getStringValue, getTagName, getValue, isRequired, isSpecified, makeUnspecified, put

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 Element_option.Attr_required.Value defaultValue

unspecified

public static final Element_option.Attr_required unspecified

Constructor Details

Attr_required

Attr_required()

Attr_required

Attr_required(Element_option.Attr_required.Value value)
       throws TdomAttributeSyntaxException

Throws:

TdomAttributeSyntaxException

Attr_required

Attr_required(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<Element_option.Attr_required.Value>

Returns:

the namespace name of the XML attribute.

setValue

public void setValue(Element_option.Attr_required.Value v)

Description copied from class: TypedAttribute

Set the value of this attribute. This method is only guaranteed to succeed if this instance has been returned by the generated method "getAttr_XXX()". The instance returned by a call to "readAttr_XXX()" is possibly the shared prototype, which will throw an exception when trying to set the value.

Overrides:

setValue in class TypedAttribute<Element_option.Attr_required.Value>

Parameters:

v - maybe null, which sets the attribute to "not specified when initializing the document", if it is declared #IMPLIED.

checkRequired

public void checkRequired()

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<Element_option.Attr_required.Value>

from

@Undocumented
public static Element_option.Attr_required 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_option.Attr_required 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<Element_option.Attr_required.Value>

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<Element_option.Attr_required.Value>

Returns:

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

getValueMap

protected final HashMap<String,? extends Element_option.Attr_required.Value> getValueMap()

Description copied from class: EnumerationAttribute

Returns a map from the external representations as appearing in the DTD to the enumeration items of the value's type. Will be overridden by the generated code.

Specified by:

getValueMap in class EnumerationAttribute<Element_option.Attr_required.Value>

getValueClass

protected final Class<Element_option.Attr_required.Value> getValueClass()

Description copied from class: EnumerationAttribute

Will be overridden in the generated code by a method which returns the dedicated value class.

Specified by:

getValueClass in class EnumerationAttribute<Element_option.Attr_required.Value>

Returns:

the Class object for the values of this attribute.

getDefaultValue

public final Element_option.Attr_required.Value getDefaultValue()

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

Specified by:

getDefaultValue in class TypedAttribute<Element_option.Attr_required.Value>

Returns:

the default value defined in the DTD.

getInterfaceInfo

public static TypedDTD.AttributeInfo getInterfaceInfo()