eu.bandm.tools.option.absy

Class Element_enumeration

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_enumeration

All Implemented Interfaces:

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

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

Meaning: An enumeration type which can be used for several parameters of several options.

<!ELEMENT enumeration ((desc)?, (enumitem)+) >.
Required attribute: name.
This class realizes the element definition from the source DTD.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Element_enumeration.Attr_name Meaning: Used to refer to this enumeration when defining the type of option parameters.

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}enumeration.
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_enumeration(Attributes attrs, Element... content) Semi-parsing constructor which tries to parse sequences of model content.
Element_enumeration(Element_desc elem_1_desc, Element_enumitem... elems_1_enumitem) Statically typed w.r.t. the contents, as far as possible.
Element_enumeration(Element... content) Semi-parsing constructor which tries to parse sequences of model elements.
Element_enumeration(TypedAttribute.SafeValues flag, Element_desc elem_1_desc, Element_enumitem... elems_1_enumitem)

Method Summary

Modifier and Type	Method and Description
void	__dumpElementSnapshot(List<TypedSubstantial<Extension>> list)
protected TypedAttribute[]	__getAllAttrs()
Element_enumeration	checkRequiredAttrs()
int	countElems_1_enumitem()
void	encode(EncodingOutputStream out, Extension ext) Abstract fall-back method which MUST be overridden and always throws an Exception.
Element_enumeration.Attr_name	getAttr_name() Meaning: Used to refer to this enumeration when defining the type of option parameters.
@Opt Element_desc	getElem_1_desc()
Element_enumitem	getElem_1_enumitem(int index)
Element_enumitem[]	getElems_1_enumitem()
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_enumeration	parse(SAXEventStream in, Extension ext, TypedNode.ParseListener<Element> listener)
Element_enumeration.Attr_name	readAttr_name() Meaning: Used to refer to this enumeration when defining the type of option parameters.
void	set(Element_desc elem_1_desc, Element_enumitem... elems_1_enumitem) Set all contents fields to a new value, after checking.
Element_desc	setElem_1_desc(@Opt Element_desc newElem_1_desc)
Element_enumitem	setElem_1_enumitem(int index, Element_enumitem newElem_1_enumitem)
Element_enumitem[]	setElems_1_enumitem(Element_enumitem... newElems_1_enumitem)
void	visitElems_1_enumitem(Visitor visitor) Sends the visitor to all items currently contained in the 1st appearance of Element_enumitem in the content model of this.

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}enumeration.

Constructor Detail

Element_enumeration

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

Statically typed w.r.t. the contents, as far as possible. 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 name.

Throws:

IllegalArgumentException - if any input to contents is null, except where explicitly allowed by (..)? in the content model.

IllegalArgumentException - if an array for a (..)+ in the content model is empty.

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

TdomAttributeSyntaxException

Element_enumeration

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

Throws:

TdomAttributeMissingException

Element_enumeration

@SafeVarargs
 @User
public Element_enumeration(@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.

IllegalArgumentException - if any input to contents is null, except where explicitly allowed by (..)? in the content model.

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

TdomAttributeSyntaxException

Element_enumeration

@SafeVarargs
 @User
public Element_enumeration(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 name.

Parameters:

content - the Element sequence to parse.

Throws:

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

IllegalArgumentException - if any input to contents is null, except where explicitly allowed by (..)? in the content model.

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

TdomAttributeSyntaxException

Method Detail

set

@User
public void set(Element_desc elem_1_desc,
                      Element_enumitem... elems_1_enumitem)

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.)

Throws:

IllegalArgumentException - if any input to contents is null, except where explicitly allowed by (..)? in the content model.

IllegalArgumentException - if an array for a (..)+ in the content model is empty.

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_name

@User
public final Element_enumeration.Attr_name getAttr_name()

Meaning: Used to refer to this enumeration when defining the type of option parameters.

Returns:

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

readAttr_name

@User
public final Element_enumeration.Attr_name readAttr_name()

Meaning: Used to refer to this enumeration when defining the type of option parameters.

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_name() 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.

getElems_1_enumitem

@User
public Element_enumitem[] getElems_1_enumitem()

Returns:

(never null) an array of all items (never null) currently contained in the 1st appearance of Element_enumitem in the content model of this. This is directly the storage of the element's contents and all manipulations affect the element instance.

getElem_1_enumitem

@User
public Element_enumitem getElem_1_enumitem(int index)

Returns:

(never null) the current value at the index position of the 1st appearance of Element_enumitem in the content model of this.

Throws:

ArrayIndexOutOfBoundsException

countElems_1_enumitem

public int countElems_1_enumitem()

Returns:

the current number of items in the 1st appearance of Element_enumitem in the content model of this.

visitElems_1_enumitem

@User
public void visitElems_1_enumitem(Visitor visitor)

Sends the visitor to all items currently contained in the 1st appearance of Element_enumitem in the content model of this.

setElem_1_enumitem

@User
public Element_enumitem setElem_1_enumitem(int index,
                                                 Element_enumitem newElem_1_enumitem)

Parameters:

newElem_1_enumitem - (never null) new value at the given index position in the 1st appearance of Element_enumitem in the content model of this.

Returns:

(never null) the overwritten value.

Throws:

IllegalArgumentException - on attempt to set null value.

IndexOutOfBoundsException - if current array is not large enough.

setElems_1_enumitem

@User
public Element_enumitem[] setElems_1_enumitem(Element_enumitem... newElems_1_enumitem)

Parameters:

newElems_1_enumitem - (never null) an array of all values (never null) in the 1st appearance of Element_enumitem in the content model of this.

Returns:

(never null) an array of the overwritten values (never null).

Throws:

IllegalArgumentException - if the array is null, or a null value is contained therein , or the array is empty.

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_enumeration 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_enumeration checkRequiredAttrs()
                                             throws TdomAttributeMissingException

Throws:

TdomAttributeMissingException

getInterfaceInfo

@User
public static TypedDTD.ElementInfo getInterfaceInfo()

Give reflexive info object about the generated class.