eu.bandm.tools.option.absy

Class Element_uri

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_uri

All Implemented Interfaces:

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

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

Meaning: Describes one uri value argument in an option's list of argument types. Is mostly used for file system positions / files.

<!ELEMENT uri ((dirOnly | notDir)?, (writable)?) >.
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_uri.Attr_default Meaning: Default value in case the option is missing completely.
static class	Element_uri.Choice_1 Realizes the content model (dirOnly | notDir)? , which is the 1st choice clause in the enclosing content model, realized by Element_uri.
static class	Element_uri.Choice_1_Alt_1 Realizes te content model dirOnly, which is the 1st alternative in the enclosing choice, realized by Element_uri.Choice_1.
static class	Element_uri.Choice_1_Alt_2 Realizes te content model notDir, which is the 2nd alternative in the enclosing choice, realized by Element_uri.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}uri.
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_uri(Attributes attrs, Element... content) Semi-parsing constructor which tries to parse sequences of model content.
Element_uri(Element_uri.Choice_1 choice_1, Element_writable elem_1_writable) Statically typed w.r.t. the contents.
Element_uri(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_uri	checkRequiredAttrs()
void	encode(EncodingOutputStream out, Extension ext) Abstract fall-back method which MUST be overridden and always throws an Exception.
Element_uri.Attr_default	getAttr_default() Meaning: Default value in case the option is missing completely.
@Opt Element_uri.Choice_1	getChoice_1()
@Opt Element_writable	getElem_1_writable()
static TypedDTD.ElementInfo	getInterfaceInfo() Give reflexive info object about the generated class.
int	getTagIndex()
boolean	hasChoice_1()
boolean	hasElem_1_writable()
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_uri	parse(SAXEventStream in, Extension ext, TypedNode.ParseListener<Element> listener)
Element_uri.Attr_default	readAttr_default() Meaning: Default value in case the option is missing completely.
void	set(Element_uri.Choice_1 choice_1, Element_writable elem_1_writable) Set all contents fields to a new value, after checking.
Element_uri.Choice_1	setChoice_1(@Opt Element_uri.Choice_1 newChoice_1)
Element_writable	setElem_1_writable(@Opt Element_writable newElem_1_writable)

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

Constructor Detail

Element_uri

@User
public Element_uri(Element_uri.Choice_1 choice_1,
                         Element_writable elem_1_writable)

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_uri

@SafeVarargs
 @User
public Element_uri(@Opt
                                       Attributes attrs,
                                       Element... 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_uri

@SafeVarargs
 @User
public Element_uri(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 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 Detail

set

@User
public void set(Element_uri.Choice_1 choice_1,
                      Element_writable elem_1_writable)

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_default

@User
public final Element_uri.Attr_default getAttr_default()

Meaning: Default value in case the option is missing completely. Must be verbatim valid Java source text.

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_uri.Attr_default readAttr_default()

Meaning: Default value in case the option is missing completely. Must be verbatim valid Java source text.

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>

hasChoice_1

@User
public boolean hasChoice_1()

Returns:

whether the 1st appearance of Element_uri.Choice_1 in the content model of this is not set to null

getChoice_1

@User
 @Opt
public @Opt Element_uri.Choice_1 getChoice_1()

Returns:

(maybe null) the current value of the 1st appearance of Element_uri.Choice_1 in the content model of this.

setChoice_1

@User
public Element_uri.Choice_1 setChoice_1(@Opt
                                              @Opt Element_uri.Choice_1 newChoice_1)

Parameters:

newChoice_1 - (maybe null) new value for the 1st appearance of Element_uri.Choice_1 in the content model of this.

Returns:

(maybe null) the overwritten value.

hasElem_1_writable

@User
public boolean hasElem_1_writable()

Returns:

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

getElem_1_writable

@User
 @Opt
public @Opt Element_writable getElem_1_writable()

Returns:

(maybe null) the current value of the 1st appearance of Element_writable in the content model of this.

setElem_1_writable

@User
public Element_writable setElem_1_writable(@Opt
                                                 @Opt Element_writable newElem_1_writable)

Parameters:

newElem_1_writable - (maybe null) new value for the 1st appearance of Element_writable in the content model of this.

Returns:

(maybe null) the overwritten value.

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.

parse

public static Element_uri 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_uri checkRequiredAttrs()

getInterfaceInfo

@User
public static TypedDTD.ElementInfo getInterfaceInfo()

Give reflexive info object about the generated class.