Package eu.bandm.tools.option.absy
Class Element_optionlist
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_optionlist
- All Implemented Interfaces:
Locatable<XMLDocumentIdentifier>
,Matchable<BaseMatcher>
,TypedContent
,Visitable<Visitor>
@Undocumented
public class Element_optionlist
extends Element
implements Visitable<Visitor>, Matchable<BaseMatcher>
Meaning: Sequence of a collection of command
line options, to
be compiled into GUI mask, online help method, parsing method, etc.
(In several contexts, the sequential order is significant.).
<!ELEMENT optionlist ((printout_title)?, (enumeration | option | comment)*) >.
Optional attributes:
setterFunctions
, defaultSorting
, fragmentedLists
.
This class realizes the element definition from the source DTD.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
static class
Meaning: Whether reperated option arguments may be continued following some other option(s).static class
Meaning: Whether setter methods will be synthesized for editing the value of an option instance.static class
Realizes the content model
(enumeration | option | comment)* ,
which is the 1st choice clause in the enclosing content model, realized byElement_optionlist
.static class
Realizes te content model
enumeration,
which is the 1st alternative in the enclosing choice, realized byElement_optionlist.Choice_1
.static class
Realizes te content model
option,
which is the 2nd alternative in the enclosing choice, realized byElement_optionlist.Choice_1
.static class
Realizes te content model
comment,
which is the 3rd alternative in the enclosing choice, realized byElement_optionlist.Choice_1
.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
FieldsModifier and TypeFieldDescription(package private) Element_optionlist.Choice_1[]
(package private) Element_printout_title
(package private) static final String
static final NamespaceName
Name of the Element is in namespace-enabled mode, namely{http://bandm.eu/doctypes/option}optionlist
.static final String
(package private) static final String
static final int
static final String
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
ConstructorsConstructorDescriptionElement_optionlist
(Element_printout_title elem_1_printout_title, Element_optionlist.Choice_1... choices_1) Statically typed w.r.t. the contents, as far as possible.Element_optionlist
(Element... content) Semi-parsing constructor which tries to parse sequences of model elements.Element_optionlist
(ContentMapping content, Extension ext, TypedNode.ParseListener<Element> listener) Element_optionlist
(Attributes attrs, Element... content) Semi-parsing constructor which tries to parse sequences of model content. -
Method Summary
Modifier and TypeMethodDescriptionvoid
protected TypedAttribute[]
final Element_optionlist
int
(package private) static Element_optionlist
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.Meaning: Whether reperated option arguments may be continued following some other option(s).Meaning: Whether setter methods will be synthesized for editing the value of an option instance.getChoice_1
(int index) (package private) static TypedContent.DecodingConstructor<? extends Element_optionlist,
Extension, TdomAttributeException> static TypedDTD.ElementInfo
Give reflexive info object about the generated class.(package private) static TypedContent.ParsingConstructor<? extends Element_optionlist,
Element, Extension, TdomAttributeException> final int
boolean
void
Send the visitor to this instance.void
identify
(BaseMatcher matcher) protected void
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_optionlist
parse
(ContentMapping content, Extension ext, TypedNode.ParseListener<Element> listener) static Element_optionlist
parse
(SAXEventStream in, Extension ext, TypedNode.ParseListener<Element> listener) (package private) static Element_optionlist
parse
(Element domElement, Extension ext, TypedNode.ParseListener<Element> listener) (package private) static Element_optionlist
parseOptional
(SAXEventStream in, Extension ext, TypedNode.ParseListener<Element> listener) (package private) static Element_optionlist[]
parsePlus
(SAXEventStream in, Extension ext, TypedNode.ParseListener<Element> listener) (package private) static Element_optionlist[]
parseStar
(SAXEventStream in, Extension ext, TypedNode.ParseListener<Element> listener) Meaning: Whether reperated option arguments may be continued following some other option(s).Meaning: Whether setter methods will be synthesized for editing the value of an option instance.(package private) static Element_optionlist
semiparse
(Iterators.MultipleLookaheadIterator<? extends Element> i) (package private) static @Opt Element_optionlist
semiparseOptional
(Iterators.MultipleLookaheadIterator<? extends Element> i) (package private) static Element_optionlist[]
semiparsePlus
(Iterators.MultipleLookaheadIterator<? extends Element> i) (package private) static Element_optionlist[]
semiparseStar
(Iterators.MultipleLookaheadIterator<? extends Element> i) void
set
(Element_printout_title elem_1_printout_title, Element_optionlist.Choice_1... choices_1) Set all contents fields to a new value, after checking.setChoice_1
(int index, Element_optionlist.Choice_1 newChoice_1) setChoices_1
(Element_optionlist.Choice_1... newChoices_1) setElem_1_printout_title
(@Opt Element_printout_title newElem_1_printout_title) void
visitChoices_1
(Visitor visitor) Sends the visitor to all items currently contained in the 1st appearance ofElement_optionlist.Choice_1
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.location.Locatable
getLocation
-
Field Details
-
TAG_INDEX
public static final int TAG_INDEX- See Also:
-
elem_1_printout_title
Element_printout_title elem_1_printout_title -
choices_1
Element_optionlist.Choice_1[] choices_1 -
TAG_NAME
The name of the element, as it appears literally in the underlying DTD.- See Also:
-
namespaceURI
- See Also:
-
prefix
- See Also:
-
localName
- See Also:
-
name
Name of the Element is in namespace-enabled mode, namely{http://bandm.eu/doctypes/option}optionlist
.
-
-
Constructor Details
-
Element_optionlist
@Undocumented public Element_optionlist(Element_printout_title elem_1_printout_title, Element_optionlist.Choice_1... choices_1) Statically typed w.r.t. the contents, as far as possible. So aTdomContentException
can not occur.
The user MAY define a subclass (mostly an anonymous one, on the fly) and overrideinitAttrs()
to set the values for the optional attributes.- Throws:
IllegalArgumentException
- if any input to contents is null, except where explicitly allowed by(..)?
in the content model.
-
Element_optionlist
Element_optionlist(ContentMapping content, Extension ext, TypedNode.ParseListener<Element> listener) throws TdomAttributeException, TdomContentException -
Element_optionlist
@SafeVarargs @Undocumented public Element_optionlist(@Opt Attributes attrs, Element... content) throws TdomAttributeSyntaxException, 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 overridinginitAttrs()
, 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.TdomAttributeSyntaxException
-
Element_optionlist
@SafeVarargs @Undocumented public Element_optionlist(Element... content) throws TdomContentException Semi-parsing constructor which tries to parse sequences of model elements. Dynamically typed.
The user MAY define a subclass (mostly an anonymous one, on the fly) and overrideinitAttrs()
to set the values for the optional attributes.- 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.
-
-
Method Details
-
set
@Undocumented public void set(Element_printout_title elem_1_printout_title, Element_optionlist.Choice_1... choices_1) Set all contents fields to a new value, after checking. Statically typed, as far as possible. So aTdomContentException
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.
-
encode
Description copied from class:TypedNode
Abstract fall-back method which MUST be overridden and always throws an Exception.- Specified by:
encode
in classTypedNode<Extension>
- Throws:
IOException
-
decode
static Element_optionlist decode(DecodingInputStream in, Extension ext) throws TdomAttributeException, IOException, TdomContentException -
__dumpElementSnapshot
- Specified by:
__dumpElementSnapshot
in classTypedElement<Element,
Extension>
-
getTagIndex
public final int getTagIndex()- Specified by:
getTagIndex
in classTypedElement<Element,
Extension>
-
getAttr_defaultSorting
- Returns:
- an implementation of that Attribute, the value of which can be
read and written.
(If only read access is needed,readAttr_defaultSorting()
should be used.)
-
readAttr_defaultSorting
- 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_defaultSorting()
must be used.)
-
getAttr_fragmentedLists
Meaning: Whether reperated option arguments may be continued following some other option(s).- Returns:
- an implementation of that Attribute, the value of which can be
read and written.
(If only read access is needed,readAttr_fragmentedLists()
should be used.)
-
readAttr_fragmentedLists
Meaning: Whether reperated option arguments may be continued following some other option(s).- 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_fragmentedLists()
must be used.)
-
getAttr_setterFunctions
Meaning: Whether setter methods will be synthesized for editing the value of an option instance.- Returns:
- an implementation of that Attribute, the value of which can be
read and written.
(If only read access is needed,readAttr_setterFunctions()
should be used.)
-
readAttr_setterFunctions
Meaning: Whether setter methods will be synthesized for editing the value of an option instance.- 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_setterFunctions()
must be used.)
-
__getAllAttrs
- Overrides:
__getAllAttrs
in classTypedElement<Element,
Extension>
-
hasElem_1_printout_title
- Returns:
- whether the 1st appearance of
Element_printout_title
in the content model of this is not set tonull
-
getElem_1_printout_title
- Returns:
- (maybe null) the current value of the 1st appearance of
Element_printout_title
in the content model of this.
-
setElem_1_printout_title
@Undocumented public Element_printout_title setElem_1_printout_title(@Opt @Opt Element_printout_title newElem_1_printout_title) - Parameters:
newElem_1_printout_title
- (maybe null) new value for the 1st appearance ofElement_printout_title
in the content model of this.- Returns:
- (maybe null) the overwritten value.
-
getChoices_1
- Returns:
- (never null) an array of all items (never null) currently
contained in the 1st appearance of
Element_optionlist.Choice_1
in the content model of this. This is directly the storage of the element's contents and all manipulations affect the element instance.
-
getChoice_1
- Returns:
- (never null) the current value at the index position of the 1st
appearance of
Element_optionlist.Choice_1
in the content model of this. - Throws:
ArrayIndexOutOfBoundsException
-
countChoices_1
public int countChoices_1()- Returns:
- the current number of items in the 1st appearance of
Element_optionlist.Choice_1
in the content model of this.
-
visitChoices_1
Sends the visitor to all items currently contained in the 1st appearance ofElement_optionlist.Choice_1
in the content model of this. -
setChoice_1
@Undocumented public Element_optionlist.Choice_1 setChoice_1(int index, Element_optionlist.Choice_1 newChoice_1) - Parameters:
newChoice_1
- (never null) new value at the given index position in the 1st appearance ofElement_optionlist.Choice_1
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.
-
setChoices_1
@Undocumented public Element_optionlist.Choice_1[] setChoices_1(Element_optionlist.Choice_1... newChoices_1) - Parameters:
newChoices_1
- (never null) an array of all values (never null) in the 1st appearance ofElement_optionlist.Choice_1
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 .
-
parse
static Element_optionlist parse(Element domElement, Extension ext, TypedNode.ParseListener<Element> listener) throws TdomAttributeException, TdomContentException -
parse
static Element_optionlist parse(ContentMapping content, Extension ext, TypedNode.ParseListener<Element> listener) throws TdomAttributeException, TdomContentException -
getParseClosure
static TypedContent.ParsingConstructor<? extends Element_optionlist,Element, getParseClosure()Extension, TdomAttributeException> -
getDecodeClosure
static TypedContent.DecodingConstructor<? extends Element_optionlist,Extension, getDecodeClosure()TdomAttributeException> -
initAttrs
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 ininitAttrs()
.- Overrides:
initAttrs
in classTypedElement<Element,
Extension> - Parameters:
attrs
- collection of (possibly superfluous, undeclared) SAX encoded attribute values.- Throws:
TdomAttributeSyntaxException
-
parseStar
static Element_optionlist[] parseStar(SAXEventStream in, Extension ext, TypedNode.ParseListener<Element> listener) throws TdomXmlException, TdomAttributeException, TdomContentException -
parsePlus
static Element_optionlist[] parsePlus(SAXEventStream in, Extension ext, TypedNode.ParseListener<Element> listener) throws TdomXmlException, TdomAttributeException, TdomContentException -
parseOptional
static Element_optionlist parseOptional(SAXEventStream in, Extension ext, TypedNode.ParseListener<Element> listener) throws TdomXmlException, TdomAttributeException, TdomContentException -
lookahead
-
parse
public static Element_optionlist parse(SAXEventStream in, Extension ext, TypedNode.ParseListener<Element> listener) throws TdomXmlException, TdomAttributeException, TdomContentException -
semiparseStar
static Element_optionlist[] semiparseStar(Iterators.MultipleLookaheadIterator<? extends Element> i) throws TdomContentException - Throws:
TdomContentException
-
semiparsePlus
static Element_optionlist[] semiparsePlus(Iterators.MultipleLookaheadIterator<? extends Element> i) throws TdomContentException - Throws:
TdomContentException
-
semiparseOptional
@Opt static @Opt Element_optionlist semiparseOptional(Iterators.MultipleLookaheadIterator<? extends Element> i) throws TdomContentException - Throws:
TdomContentException
-
lookahead
static boolean lookahead(Iterators.MultipleLookaheadIterator<? extends Element> i, boolean optional) -
semiparse
static Element_optionlist semiparse(Iterators.MultipleLookaheadIterator<? extends Element> i) throws TdomContentException - Throws:
TdomContentException
-
host
Description copied from interface:Visitable
Send the visitor to this instance. -
identify
- Specified by:
identify
in interfaceMatchable<BaseMatcher>
-
initAttrs
protected void initAttrs() -
checkRequiredAttrs
-
getInterfaceInfo
Give reflexive info object about the generated class.
-