eu.bandm.tools.option.absy

Class Element_enumitem

java.lang.Object

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

eu.bandm.tools.tdom.runtime.TypedSubstantial<X>

eu.bandm.tools.tdom.runtime.TypedElement<Element,Extension>

eu.bandm.tools.option.absy.Element

eu.bandm.tools.option.absy.Element_enumitem

All Implemented Interfaces:

Locatable<XMLDocumentIdentifier>, Matchable<BaseMatcher>, TypedContent, Visitable<Visitor>

@User
public class Element_enumitem
extends Element
implements Visitable<Visitor>, Matchable<BaseMatcher>

Meaning: One position in an enumeration type (represented by the enclosing context element).

<!ELEMENT enumitem (desc)? >.
Required attribute: value.
Optional attribute: compilable.
This class realizes the element definition from the source DTD.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Element_enumitem.Attr_compilable Meaning: Text as which this item is realized in the generated code.
static class	Element_enumitem.Attr_value Meaning: Text as which this item appears to the user, on the command line, in a GUI, etc.

Nested classes/interfaces inherited from class eu.bandm.tools.option.absy.Element

Element.UnmixedContent

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

TypedElement.AttributeDecoder, TypedElement.AttributeEncoder, TypedElement.MixedContent<E extends TypedElement<E,X>,X extends TypedExtension>, TypedElement.MixedContentContainer, TypedElement.MixedContentFactory<C extends TypedElement.MixedContent<E,X>,E extends TypedElement<E,X>,X extends TypedExtension,Y extends Exception>, TypedElement.PCDataContainer

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

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

Nested classes/interfaces inherited from interface eu.bandm.tools.tdom.runtime.TypedContent

TypedContent.DecodingConstructor<C extends TypedContent,X extends TypedExtension,Y extends Exception>, TypedContent.ParsingConstructor<C extends TypedContent,E extends TypedElement<E,X>,X extends TypedExtension,Y extends Exception>

Field Summary

Fields

Modifier and Type	Field and Description
static NamespaceName	name Name of the Element is in namespace-enabled mode, namely {http://bandm.eu/doctypes/option}enumitem.
static int	TAG_INDEX
static String	TAG_NAME The name of the element, as it appears literally in the underlying DTD.

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

getDeepPCData, getFlatPCData

Constructor Summary

Constructors

Constructor and Description
Element_enumitem(Attributes attrs, Element... content) Semi-parsing constructor which tries to parse sequences of model content.
Element_enumitem(Element_desc elem_1_desc) Statically typed w.r.t. the contents.
Element_enumitem(Element... content) Semi-parsing constructor which tries to parse sequences of model elements.
Element_enumitem(TypedAttribute.SafeValues flag, Element_desc elem_1_desc)

Method Summary

Modifier and Type	Method and Description
void	__dumpElementSnapshot(List<TypedSubstantial<Extension>> list)
protected TypedAttribute[]	__getAllAttrs()
Element_enumitem	checkRequiredAttrs()
void	encode(EncodingOutputStream out, Extension ext) Abstract fall-back method which MUST be overridden and always throws an Exception.
Element_enumitem.Attr_compilable	getAttr_compilable() Meaning: Text as which this item is realized in the generated code.
Element_enumitem.Attr_value	getAttr_value() Meaning: Text as which this item appears to the user, on the command line, in a GUI, etc.
@Opt Element_desc	getElem_1_desc()
static TypedDTD.ElementInfo	getInterfaceInfo() Give reflexive info object about the generated class.
int	getTagIndex()
boolean	hasElem_1_desc()
void	host(Visitor visitor) Send the visitor to this instance.
void	identify(BaseMatcher matcher)
protected void	initAttrs()
protected void	initAttrs(Attributes attrs) Pick attribute values from the argument and copy them to the attribute values of this element.
protected void	initAttrsSafe()
static Element_enumitem	parse(SAXEventStream in, Extension ext, TypedNode.ParseListener<Element> listener)
Element_enumitem.Attr_compilable	readAttr_compilable() Meaning: Text as which this item is realized in the generated code.
Element_enumitem.Attr_value	readAttr_value() Meaning: Text as which this item appears to the user, on the command line, in a GUI, etc.
void	set(Element_desc elem_1_desc) Set all contents fields to a new value, after checking.
Element_desc	setElem_1_desc(@Opt Element_desc newElem_1_desc)

Methods inherited from class eu.bandm.tools.option.absy.Element

getDeepPCData

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

classifyForException, decodeMixed, decodeOptional, decodePlus, decodePlusList, decodeStar, decodeStarList, encode, encodeMixed, end, ensureSize, extractElement, getAttrsSnapshot, getAttrsSnapshot, getElemsSnapshot, getEtherealContainer, getLocalName, getName, getNamespaceURI, getPCData, getTagName, initAttrs, initAttrsSafe, matchEndElement, matchEndElement, matchStartElement, matchStartElement, parseAbstract, parseAndClose, parseAndClose, parseMixed, parseMixed, parseOptional, parsePlus, parsePlusList, parseStar, parseStarList, semiparseEmpty, semiparseMixed, setResizing, start, w3c_getNamespaceName

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

dumpFollowingEthereals, dumpPrecedingEthereals, getFollowingEthereals, getPrecedingEthereals, readFollowingEthereals, readPrecedingEthereals

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, 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

Methods inherited from interface eu.bandm.tools.message.Locatable

getLocation

Field Detail

TAG_INDEX

public static final int TAG_INDEX

See Also:

Constant Field Values

TAG_NAME

public static final String TAG_NAME

The name of the element, as it appears literally in the underlying DTD.

See Also:

Constant Field Values

name

public static final NamespaceName name

Name of the Element is in namespace-enabled mode, namely {http://bandm.eu/doctypes/option}enumitem.

Constructor Detail

Element_enumitem

@User
public Element_enumitem(Element_desc elem_1_desc)
                       throws TdomAttributeSyntaxException,
                              TdomAttributeMissingException

Statically typed w.r.t. the contents. So a TdomContentException can not occur.
The user MUST define a subclass (mostly an anonymous one, on the fly) and override initAttrs() to set the values for the required attribute value, plus optional attributes ad lib.

Throws:

TdomAttributeMissingException - if no value for required attribute value is set explicitly.

TdomAttributeSyntaxException

Element_enumitem

public Element_enumitem(TypedAttribute.SafeValues flag,
                        Element_desc elem_1_desc)
                 throws TdomAttributeMissingException

Throws:

TdomAttributeMissingException

Element_enumitem

@SafeVarargs
 @User
public Element_enumitem(@Opt
                                            Attributes attrs,
                                            Element... content)
                                     throws TdomAttributeSyntaxException,
                                            TdomContentException,
                                            TdomAttributeMissingException

Semi-parsing constructor which tries to parse sequences of model content. Dynamically typed.

Parameters:

attrs - (maybe null) A SAX auxiliary attribute store, from which values for the attributes defined for this element will be picked. (Undefined attributes are ignored; a value of null leaves the attribute default values untouched; all attribute values can be overridden by overriding initAttrs(), which is called after this picking.)

content - the Element sequence to parse.

Throws:

TdomContentException - if the sequence in 'contents' does not match the content model.

TdomAttributeMissingException - if there is no value contained in param attrs nor set in initAttrs() for required attribute value.

TdomAttributeSyntaxException

Element_enumitem

@SafeVarargs
 @User
public Element_enumitem(Element... content)
                                     throws TdomAttributeSyntaxException,
                                            TdomContentException,
                                            TdomAttributeMissingException

Semi-parsing constructor which tries to parse sequences of model elements. Dynamically typed.
The user MUST define a subclass (mostly an anonymous one, on the fly) and override initAttrs() to set the values for the required attribute value, plus optional attributes ad lib.

Parameters:

content - the Element sequence to parse.

Throws:

TdomContentException - if the sequence in 'contents' does not match the content model.

TdomAttributeMissingException - if no value for required attribute value is set explicitly.

TdomAttributeSyntaxException

Method Detail

set

@User
public void set(Element_desc elem_1_desc)

Set all contents fields to a new value, after checking. Statically typed, as far as possible. So a TdomContentException can not occur.
(Values of Attributes are not affected.)

encode

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

Description copied from class: TypedNode

Abstract fall-back method which MUST be overridden and always throws an Exception.

Specified by:

encode in class TypedNode<Extension>

Throws:

IOException

__dumpElementSnapshot

public void __dumpElementSnapshot(List<TypedSubstantial<Extension>> list)

Specified by:

__dumpElementSnapshot in class TypedElement<Element,Extension>

getTagIndex

public final int getTagIndex()

Specified by:

getTagIndex in class TypedElement<Element,Extension>

getAttr_value

@User
public final Element_enumitem.Attr_value getAttr_value()

Meaning: Text as which this item appears to the user, on the command line, in a GUI, etc. It maybe not a valid Java identifier. In this case @compilable must be given.

Returns:

an implementation of that Attribute, the value of which can be read and written.
(If only read access is needed, readAttr_value() should be used.)

readAttr_value

@User
public final Element_enumitem.Attr_value readAttr_value()

Meaning: Text as which this item appears to the user, on the command line, in a GUI, etc. It maybe not a valid Java identifier. In this case @compilable must be given.

Returns:

an implementation of that Attribute, the value of which can be read, but is not guaranteed to be writable.
(If write access is needed, getAttr_value() must be used.)

getAttr_compilable

@User
public final Element_enumitem.Attr_compilable getAttr_compilable()

Meaning: Text as which this item is realized in the generated code. It must be a valid Java identifier, and must be present if @value is not.

Returns:

an implementation of that Attribute, the value of which can be read and written.
(If only read access is needed, readAttr_compilable() should be used.)

readAttr_compilable

@User
public final Element_enumitem.Attr_compilable readAttr_compilable()

Meaning: Text as which this item is realized in the generated code. It must be a valid Java identifier, and must be present if @value is not.

Returns:

an implementation of that Attribute, the value of which can be read, but is not guaranteed to be writable.
(If write access is needed, getAttr_compilable() must be used.)

__getAllAttrs

protected TypedAttribute[] __getAllAttrs()

Overrides:

__getAllAttrs in class TypedElement<Element,Extension>

hasElem_1_desc

@User
public boolean hasElem_1_desc()

Returns:

whether the 1st appearance of Element_desc in the content model of this is not set to null

getElem_1_desc

@User
 @Opt
public @Opt Element_desc getElem_1_desc()

Returns:

(maybe null) the current value of the 1st appearance of Element_desc in the content model of this.

setElem_1_desc

@User
public Element_desc setElem_1_desc(@Opt
                                         @Opt Element_desc newElem_1_desc)

Parameters:

newElem_1_desc - (maybe null) new value for the 1st appearance of Element_desc in the content model of this.

Returns:

(maybe null) the overwritten value.

initAttrs

protected void initAttrs(Attributes attrs)
                  throws TdomAttributeSyntaxException

Pick attribute values from the argument and copy them to the attribute values of this element. Will be called on constructor operation before the explicit override in initAttrs().

Overrides:

initAttrs in class TypedElement<Element,Extension>

Parameters:

attrs - collection of (possibly superfluous, undeclared) SAX encoded attribute values.

Throws:

TdomAttributeSyntaxException

parse

public static Element_enumitem parse(SAXEventStream in,
                                     Extension ext,
                                     TypedNode.ParseListener<Element> listener)
                              throws TdomAttributeException,
                                     TdomContentException,
                                     TdomXmlException

Throws:

TdomAttributeException

TdomContentException

TdomXmlException

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(BaseMatcher matcher)

Specified by:

identify in interface Matchable<BaseMatcher>

initAttrs

protected void initAttrs()
                  throws TdomAttributeSyntaxException

Throws:

TdomAttributeSyntaxException

initAttrsSafe

protected void initAttrsSafe()

checkRequiredAttrs

public final Element_enumitem checkRequiredAttrs()
                                          throws TdomAttributeMissingException

Throws:

TdomAttributeMissingException

getInterfaceInfo

@User
public static TypedDTD.ElementInfo getInterfaceInfo()

Give reflexive info object about the generated class.