Package eu.bandm.tools.option.absy

Class Element_desc

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_desc

All Implemented Interfaces:

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

@Undocumented
public class Element_desc
extends Element
implements Visitable<Visitor>, Matchable<BaseMatcher>

Meaning: One description, in several languages. (Its role and meaning depend on the enclosing context element.).

<!ELEMENT desc (text)+ >.
This class realizes the element definition from the source DTD.

Nested Class Summary

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	Description
(package private) Element_text[]	elems_1_text
(package private) static final String	localName
static final NamespaceName	name	Name of the Element is in namespace-enabled mode, namely {http://bandm.eu/doctypes/option}desc.
(package private) static final String	namespaceURI
(package private) static final String	prefix
static final int	TAG_INDEX
static final String	TAG_NAME	The name of the element, as it appears literally in the underlying DTD.

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

decodeTable, parseTable

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

getDeepPCData, getFlatPCData

Constructor Summary

Constructors

Constructor	Description
Element_desc()	Statically typed w.r.t. the contents; a TdomContentException can not occur.
Element_desc(Element_text... elems_1_text)	Statically typed w.r.t. the contents, as far as possible.
Element_desc(Element... content)	Semi-parsing constructor which tries to parse sequences of model elements.
Element_desc(ContentMapping content, Extension ext, TypedNode.ParseListener<Element> listener)
Element_desc(Attributes attrs, Element... content)	Semi-parsing constructor which tries to parse sequences of model content.

Method Summary

Modifier and Type	Method	Description
void	__dumpElementSnapshot(List<TypedSubstantial<Extension>> list)
final Element_desc	checkRequiredAttrs()
int	countElems_1_text()
(package private) static Element_desc	decode(DecodingInputStream in, Extension ext)
final void	encode(EncodingOutputStream out, Extension ext)	Abstract fall-back method which MUST be overridden and always throws an Exception.
(package private) static TypedContent.DecodingConstructor<? extends Element_desc,Extension,TdomAttributeException>	getDecodeClosure()
Element_text	getElem_1_text(int index)
Element_text[]	getElems_1_text()
static TypedDTD.ElementInfo	getInterfaceInfo()	Give reflexive info object about the generated class.
(package private) static TypedContent.ParsingConstructor<? extends Element_desc,Element,Extension,TdomAttributeException>	getParseClosure()
final int	getTagIndex()
void	host(Visitor visitor)	Send the visitor to this instance.
void	identify(BaseMatcher matcher)
(package private) static boolean	lookahead(Iterators.MultipleLookaheadIterator<? extends Element> i, boolean optional)
(package private) static boolean	lookahead(SAXEventStream in, Extension ext, boolean optional)
(package private) static Element_desc	parse(ContentMapping content, Extension ext, TypedNode.ParseListener<Element> listener)
static Element_desc	parse(SAXEventStream in, Extension ext, TypedNode.ParseListener<Element> listener)
(package private) static Element_desc	parse(Element domElement, Extension ext, TypedNode.ParseListener<Element> listener)
(package private) static Element_desc	parseOptional(SAXEventStream in, Extension ext, TypedNode.ParseListener<Element> listener)
(package private) static Element_desc[]	parsePlus(SAXEventStream in, Extension ext, TypedNode.ParseListener<Element> listener)
(package private) static Element_desc[]	parseStar(SAXEventStream in, Extension ext, TypedNode.ParseListener<Element> listener)
(package private) static Element_desc	semiparse(Iterators.MultipleLookaheadIterator<? extends Element> i)
(package private) static @Opt Element_desc	semiparseOptional(Iterators.MultipleLookaheadIterator<? extends Element> i)
(package private) static Element_desc[]	semiparsePlus(Iterators.MultipleLookaheadIterator<? extends Element> i)
(package private) static Element_desc[]	semiparseStar(Iterators.MultipleLookaheadIterator<? extends Element> i)
void	set(Element_text... elems_1_text)	Set all contents fields to a new value, after checking.
Element_text	setElem_1_text(int index, Element_text newElem_1_text)
Element_text[]	setElems_1_text(Element_text... newElems_1_text)
void	visitElems_1_text(Visitor visitor)	Sends the visitor to all items currently contained in the 1st appearance of Element_text 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

__getAllAttrs, classifyForException, decodeMixed, decodeOptional, decodePlus, decodePlusList, decodeStar, decodeStarList, encode, encodeMixed, end, ensureSize, extractElement, getAttrsSnapshot, getAttrsSnapshot, getElemsSnapshot, getEtherealContainer, getLocalName, getName, getNamespaceURI, getPCData, getTagName, initAttrs, 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.location.Locatable

getLocation

Field Details

TAG_INDEX

public static final int TAG_INDEX

See Also:

• Constant Field Values

elems_1_text

Element_text[] elems_1_text

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

namespaceURI

static final String namespaceURI

See Also:

• Constant Field Values

prefix

static final String prefix

See Also:

• Constant Field Values

localName

static final String localName

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

Constructor Details

Element_desc

@Undocumented
public Element_desc(Element_text... elems_1_text)

Statically typed w.r.t. the contents, as far as possible. So a TdomContentException can not occur.

Throws:

IllegalArgumentException - if any input to contents is null.

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

Element_desc

Element_desc(ContentMapping content,
 Extension ext,
 TypedNode.ParseListener<Element> listener)
      throws TdomAttributeException,
TdomContentException

Throws:

TdomAttributeException

TdomContentException

Element_desc

public Element_desc()

Statically typed w.r.t. the contents; a TdomContentException can not occur.

Element_desc

@SafeVarargs
@Undocumented
public Element_desc(@Opt
 Attributes attrs,
 Element... content)
             throws TdomContentException

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

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.

Element_desc

@SafeVarargs
@Undocumented
public Element_desc(Element... content)
             throws TdomContentException

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

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.

Method Details

set

@Undocumented
public void set(Element_text... elems_1_text)

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.

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

decode

static Element_desc decode(DecodingInputStream in,
 Extension ext)
                    throws IOException,
TdomAttributeException,
TdomContentException

Throws:

IOException

TdomAttributeException

TdomContentException

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

getElems_1_text

@Undocumented
public Element_text[] getElems_1_text()

Returns:

(never null) an array of all items (never null) currently contained in the 1st appearance of Element_text 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_text

@Undocumented
public Element_text getElem_1_text(int index)

Returns:

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

Throws:

ArrayIndexOutOfBoundsException

countElems_1_text

public int countElems_1_text()

Returns:

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

visitElems_1_text

@Undocumented
public void visitElems_1_text(Visitor visitor)

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

setElem_1_text

@Undocumented
public Element_text setElem_1_text(int index,
 Element_text newElem_1_text)

Parameters:

newElem_1_text - (never null) new value at the given index position in the 1st appearance of Element_text 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_text

@Undocumented
public Element_text[] setElems_1_text(Element_text... newElems_1_text)

Parameters:

newElems_1_text - (never null) an array of all values (never null) in the 1st appearance of Element_text 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.

parse

static Element_desc parse(Element domElement,
 Extension ext,
 TypedNode.ParseListener<Element> listener)
                   throws TdomAttributeException,
TdomContentException

Throws:

TdomAttributeException

TdomContentException

parse

static Element_desc parse(ContentMapping content,
 Extension ext,
 TypedNode.ParseListener<Element> listener)
                   throws TdomAttributeException,
TdomContentException

Throws:

TdomAttributeException

TdomContentException

getParseClosure

static TypedContent.ParsingConstructor<? extends Element_desc,Element,Extension,TdomAttributeException> getParseClosure()

getDecodeClosure

static TypedContent.DecodingConstructor<? extends Element_desc,Extension,TdomAttributeException> getDecodeClosure()

parseStar

static Element_desc[] parseStar(SAXEventStream in,
 Extension ext,
 TypedNode.ParseListener<Element> listener)
                         throws TdomAttributeException,
TdomContentException,
TdomXmlException

Throws:

TdomAttributeException

TdomContentException

TdomXmlException

parsePlus

static Element_desc[] parsePlus(SAXEventStream in,
 Extension ext,
 TypedNode.ParseListener<Element> listener)
                         throws TdomAttributeException,
TdomContentException,
TdomXmlException

Throws:

TdomAttributeException

TdomContentException

TdomXmlException

parseOptional

static Element_desc parseOptional(SAXEventStream in,
 Extension ext,
 TypedNode.ParseListener<Element> listener)
                           throws TdomAttributeException,
TdomContentException,
TdomXmlException

Throws:

TdomAttributeException

TdomContentException

TdomXmlException

lookahead

static boolean lookahead(SAXEventStream in,
 Extension ext,
 boolean optional)

parse

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

Throws:

TdomAttributeException

TdomContentException

TdomXmlException

semiparseStar

static Element_desc[] semiparseStar(Iterators.MultipleLookaheadIterator<? extends Element> i)
                             throws TdomContentException

Throws:

TdomContentException

semiparsePlus

static Element_desc[] semiparsePlus(Iterators.MultipleLookaheadIterator<? extends Element> i)
                             throws TdomContentException

Throws:

TdomContentException

semiparseOptional

@Opt
static @Opt Element_desc semiparseOptional(Iterators.MultipleLookaheadIterator<? extends Element> i)
                                    throws TdomContentException

Throws:

TdomContentException

lookahead

static boolean lookahead(Iterators.MultipleLookaheadIterator<? extends Element> i,
 boolean optional)

semiparse

static Element_desc semiparse(Iterators.MultipleLookaheadIterator<? extends Element> i)
                       throws TdomContentException

Throws:

TdomContentException

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>

checkRequiredAttrs

public final Element_desc checkRequiredAttrs()

getInterfaceInfo

@Undocumented
public static TypedDTD.ElementInfo getInterfaceInfo()

Give reflexive info object about the generated class.