Package eu.bandm.tools.option.absy

Class Element_string

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_string

All Implemented Interfaces:

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

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

Meaning: Describes one string value argument in an option's list of argument types.

<!ELEMENT string EMPTY >.
Optional attribute: default.
This class realizes the element definition from the source DTD.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Element_string.Attr_default	Meaning: Default value in case the option is missing completely.

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) static final String	localName
static final NamespaceName	name	Name of the Element is in namespace-enabled mode, namely {http://bandm.eu/doctypes/option}string.
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_string()	Statically typed w.r.t. the contents.
Element_string(ContentMapping content, Extension ext, TypedNode.ParseListener<Element> listener)
Element_string(TypedSubstantial<Extension>... content)	Semi-parsing constructor which tries to parse sequences of model elements.
Element_string(Attributes attrs, TypedSubstantial<Extension>... 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)
protected TypedAttribute[]	__getAllAttrs()
final Element_string	checkRequiredAttrs()
(package private) static Element_string	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.
final Element_string.Attr_default	getAttr_default()	Meaning: Default value in case the option is missing completely.
(package private) static TypedContent.DecodingConstructor<? extends Element_string,Extension,TdomAttributeException>	getDecodeClosure()
static TypedDTD.ElementInfo	getInterfaceInfo()	Give reflexive info object about the generated class.
(package private) static TypedContent.ParsingConstructor<? extends Element_string,Element,Extension,TdomAttributeException>	getParseClosure()
final int	getTagIndex()
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.
(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_string	parse(ContentMapping content, Extension ext, TypedNode.ParseListener<Element> listener)
static Element_string	parse(SAXEventStream in, Extension ext, TypedNode.ParseListener<Element> listener)
(package private) static Element_string	parse(Element domElement, Extension ext, TypedNode.ParseListener<Element> listener)
(package private) static Element_string	parseOptional(SAXEventStream in, Extension ext, TypedNode.ParseListener<Element> listener)
(package private) static Element_string[]	parsePlus(SAXEventStream in, Extension ext, TypedNode.ParseListener<Element> listener)
(package private) static Element_string[]	parseStar(SAXEventStream in, Extension ext, TypedNode.ParseListener<Element> listener)
final Element_string.Attr_default	readAttr_default()	Meaning: Default value in case the option is missing completely.
(package private) static Element_string	semiparse(Iterators.MultipleLookaheadIterator<? extends Element> i)
(package private) static @Opt Element_string	semiparseOptional(Iterators.MultipleLookaheadIterator<? extends Element> i)
(package private) static Element_string[]	semiparsePlus(Iterators.MultipleLookaheadIterator<? extends Element> i)
(package private) static Element_string[]	semiparseStar(Iterators.MultipleLookaheadIterator<? extends Element> i)
void	set()	Set all contents fields to a new value, after checking.

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.location.Locatable

getLocation

Field Details

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

namespaceURI

public 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}string.

Constructor Details

Element_string

@Undocumented
public Element_string()

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

Element_string

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

Throws:

TdomAttributeException

TdomContentException

Element_string

@SafeVarargs
@Undocumented
public Element_string(@Opt
 Attributes attrs,
 TypedSubstantial<Extension>... content)
               throws TdomContentException

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.

Element_string

@SafeVarargs
public Element_string(TypedSubstantial<Extension>... content)
               throws TdomContentException

Semi-parsing constructor which tries to parse sequences of model elements. Dynamically typed. (This constructor will always fail, because the only correct contents are empty and match a different constructor.
The user MAY define a subclass (mostly an anonymous one, on the fly) and override initAttrs() to set the value for the optional attribute.

Parameters:

content - the Element sequence to parse.

Throws:

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

Method Details

set

public void set()

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

decode

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

Throws:

TdomAttributeException

IOException

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>

getAttr_default

@Undocumented
public final Element_string.Attr_default getAttr_default()

Meaning: Default value in case the option is missing completely. Can be any string (without framing double quotes) which will be processed into a valid String constant.

Returns:

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

readAttr_default

@Undocumented
public final Element_string.Attr_default readAttr_default()

Meaning: Default value in case the option is missing completely. Can be any string (without framing double quotes) which will be processed into a valid String constant.

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_default() must be used.)

__getAllAttrs

protected TypedAttribute[] __getAllAttrs()

Overrides:

__getAllAttrs in class TypedElement<Element,Extension>

parse

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

Throws:

TdomAttributeException

TdomContentException

parse

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

Throws:

TdomAttributeException

TdomContentException

getParseClosure

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

getDecodeClosure

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

initAttrs

protected void initAttrs(Attributes attrs)

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.

parseStar

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

Throws:

TdomXmlException

TdomAttributeException

TdomContentException

parsePlus

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

Throws:

TdomXmlException

TdomAttributeException

TdomContentException

parseOptional

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

Throws:

TdomXmlException

TdomAttributeException

TdomContentException

lookahead

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

parse

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

Throws:

TdomXmlException

TdomAttributeException

TdomContentException

semiparseStar

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

Throws:

TdomContentException

semiparsePlus

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

Throws:

TdomContentException

semiparseOptional

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

Throws:

TdomContentException

lookahead

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

semiparse

static Element_string 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>

initAttrs

protected void initAttrs()

checkRequiredAttrs

public final Element_string checkRequiredAttrs()

getInterfaceInfo

@Undocumented
public static TypedDTD.ElementInfo getInterfaceInfo()

Give reflexive info object about the generated class.