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>

@User
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: hexadecimalIntegers, setterFunctions, defaultSorting, fragmentedLists.
This class realizes the element definition from the source DTD.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Element_optionlist.Attr_defaultSorting
static class	Element_optionlist.Attr_fragmentedLists Meaning: Whether reperated option arguments may be continued following some other option(s).
static class	Element_optionlist.Attr_hexadecimalIntegers
static class	Element_optionlist.Attr_setterFunctions Meaning: Whether setter methods will be synthesized for editing the value of an option instance.
static class	Element_optionlist.Choice_1 Realizes the content model (enumeration | option | comment)* , which is the 1st choice clause in the enclosing content model, realized by Element_optionlist.
static class	Element_optionlist.Choice_1_Alt_1 Realizes te content model enumeration, which is the 1st alternative in the enclosing choice, realized by Element_optionlist.Choice_1.
static class	Element_optionlist.Choice_1_Alt_2 Realizes te content model option, which is the 2nd alternative in the enclosing choice, realized by Element_optionlist.Choice_1.
static class	Element_optionlist.Choice_1_Alt_3 Realizes te content model comment, which is the 3rd alternative in the enclosing choice, realized by Element_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

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}optionlist.
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_optionlist(Attributes attrs, Element... content) Semi-parsing constructor which tries to parse sequences of model content.
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.
Element_optionlist(Element... content) Semi-parsing constructor which tries to parse sequences of model elements.

Method Summary

Modifier and Type	Method and Description
void	__dumpElementSnapshot(List<TypedSubstantial<Extension>> list)
protected TypedAttribute[]	__getAllAttrs()
Element_optionlist	checkRequiredAttrs()
int	countChoices_1()
void	encode(EncodingOutputStream out, Extension ext) Abstract fall-back method which MUST be overridden and always throws an Exception.
Element_optionlist.Attr_defaultSorting	getAttr_defaultSorting()
Element_optionlist.Attr_fragmentedLists	getAttr_fragmentedLists() Meaning: Whether reperated option arguments may be continued following some other option(s).
Element_optionlist.Attr_hexadecimalIntegers	getAttr_hexadecimalIntegers()
Element_optionlist.Attr_setterFunctions	getAttr_setterFunctions() Meaning: Whether setter methods will be synthesized for editing the value of an option instance.
Element_optionlist.Choice_1	getChoice_1(int index)
Element_optionlist.Choice_1[]	getChoices_1()
@Opt Element_printout_title	getElem_1_printout_title()
static TypedDTD.ElementInfo	getInterfaceInfo() Give reflexive info object about the generated class.
int	getTagIndex()
boolean	hasElem_1_printout_title()
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.
static Element_optionlist	parse(SAXEventStream in, Extension ext, TypedNode.ParseListener<Element> listener)
Element_optionlist.Attr_defaultSorting	readAttr_defaultSorting()
Element_optionlist.Attr_fragmentedLists	readAttr_fragmentedLists() Meaning: Whether reperated option arguments may be continued following some other option(s).
Element_optionlist.Attr_hexadecimalIntegers	readAttr_hexadecimalIntegers()
Element_optionlist.Attr_setterFunctions	readAttr_setterFunctions() Meaning: Whether setter methods will be synthesized for editing the value of an option instance.
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.
Element_optionlist.Choice_1	setChoice_1(int index, Element_optionlist.Choice_1 newChoice_1)
Element_optionlist.Choice_1[]	setChoices_1(Element_optionlist.Choice_1... newChoices_1)
Element_printout_title	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 of Element_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.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}optionlist.

Constructor Detail

Element_optionlist

@User
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 a TdomContentException can not occur.
The user MAY define a subclass (mostly an anonymous one, on the fly) and override initAttrs() 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

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

TdomAttributeSyntaxException

Element_optionlist

@SafeVarargs
 @User
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 override initAttrs() 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 Detail

set

@User
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 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.

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_defaultSorting

@User
public final Element_optionlist.Attr_defaultSorting 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

@User
public final Element_optionlist.Attr_defaultSorting 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

@User
public final Element_optionlist.Attr_fragmentedLists 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

@User
public final Element_optionlist.Attr_fragmentedLists 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

@User
public final Element_optionlist.Attr_setterFunctions 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

@User
public final Element_optionlist.Attr_setterFunctions 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.)

getAttr_hexadecimalIntegers

@User
public final Element_optionlist.Attr_hexadecimalIntegers getAttr_hexadecimalIntegers()

Returns:

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

readAttr_hexadecimalIntegers

@User
public final Element_optionlist.Attr_hexadecimalIntegers readAttr_hexadecimalIntegers()

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

__getAllAttrs

protected TypedAttribute[] __getAllAttrs()

Overrides:

__getAllAttrs in class TypedElement<Element,Extension>

hasElem_1_printout_title

@User
public boolean hasElem_1_printout_title()

Returns:

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

getElem_1_printout_title

@User
 @Opt
public @Opt Element_printout_title 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

@User
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 of Element_printout_title in the content model of this.

Returns:

(maybe null) the overwritten value.

getChoices_1

@User
public Element_optionlist.Choice_1[] 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

@User
public Element_optionlist.Choice_1 getChoice_1(int index)

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

@User
public void visitChoices_1(Visitor visitor)

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

setChoice_1

@User
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 of Element_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

@User
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 of Element_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 .

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_optionlist 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()

checkRequiredAttrs

public final Element_optionlist checkRequiredAttrs()

getInterfaceInfo

@User
public static TypedDTD.ElementInfo getInterfaceInfo()

Give reflexive info object about the generated class.