eu.bandm.tools.option.absy

Class Element_enumset

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_enumset

All Implemented Interfaces:

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

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

Meaning: Refers to an Enumeration as the base type for a set type for the value of an option's argument.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Element_enumset.Attr_default Meaning: The enumeration items which make the set value be used as default value, if the option is missing completely.
static class	Element_enumset.Attr_name Meaning: The name of the enum, for referring.

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}enumset.
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_enumset() Statically typed w.r.t. the contents.
Element_enumset(Attributes attrs, TypedSubstantial<Extension>... content) Semi-parsing constructor which tries to parse sequences of model content.
Element_enumset(TypedAttribute.SafeValues flag)
Element_enumset(TypedSubstantial<Extension>... 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_enumset	checkRequiredAttrs()
void	encode(EncodingOutputStream out, Extension ext) Abstract fall-back method which MUST be overridden and always throws an Exception.
Element_enumset.Attr_default	getAttr_default() Meaning: The enumeration items which make the set value be used as default value, if the option is missing completely.
Element_enumset.Attr_name	getAttr_name() Meaning: The name of the enum, for referring.
static TypedDTD.ElementInfo	getInterfaceInfo() Give reflexive info object about the generated class.
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.
protected void	initAttrsSafe()
static Element_enumset	parse(SAXEventStream in, Extension ext, TypedNode.ParseListener<Element> listener)
Element_enumset.Attr_default	readAttr_default() Meaning: The enumeration items which make the set value be used as default value, if the option is missing completely.
Element_enumset.Attr_name	readAttr_name() Meaning: The name of the enum, for referring.
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.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}enumset.

Constructor Detail

Element_enumset

@User
public Element_enumset()
                      throws TdomAttributeSyntaxException,
                             TdomAttributeMissingException

Statically typed w.r.t. the contents. 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, plus optional attributes ad lib.

Throws:

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

TdomAttributeSyntaxException

Element_enumset

public Element_enumset(TypedAttribute.SafeValues flag)
                throws TdomAttributeMissingException

Throws:

TdomAttributeMissingException

Element_enumset

@SafeVarargs
 @User
public Element_enumset(@Opt
                                           Attributes attrs,
                                           TypedSubstantial<Extension>... 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.

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

TdomAttributeSyntaxException

Element_enumset

@SafeVarargs
public Element_enumset(TypedSubstantial<Extension>... content)
                             throws TdomAttributeSyntaxException,
                                    TdomContentException,
                                    TdomAttributeMissingException

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 MUST define a subclass (mostly an anonymous one, on the fly) and override initAttrs() to set the values for the required attribute name, plus optional attributes ad lib.

Parameters:

content - the Element sequence to parse.

Throws:

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

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

TdomAttributeSyntaxException

Method Detail

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

__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_enumset.Attr_name getAttr_name()

Meaning: The name of the enum, for referring.

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_enumset.Attr_name readAttr_name()

Meaning: The name of the enum, for referring.

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

getAttr_default

@User
public final Element_enumset.Attr_default getAttr_default()

Meaning: The enumeration items which make the set value be used as default value, if the option is missing completely. The text must be a sequence of Java identifiers, i.e. the compilable versions, not the command line versions.

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

@User
public final Element_enumset.Attr_default readAttr_default()

Meaning: The enumeration items which make the set value be used as default value, if the option is missing completely. The text must be a sequence of Java identifiers, i.e. the compilable versions, not the command line versions.

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>

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

Throws:

TdomAttributeMissingException

getInterfaceInfo

@User
public static TypedDTD.ElementInfo getInterfaceInfo()

Give reflexive info object about the generated class.