eu.bandm.tools.option.absy

Class Element_text

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_text

All Implemented Interfaces:

Locatable<XMLDocumentIdentifier>, Matchable<BaseMatcher>, TypedContent, TypedElement.MixedContentContainer, TypedElement.PCDataContainer, Visitable<Visitor>

@User
public class Element_text
extends Element
implements TypedElement.PCDataContainer, Visitable<Visitor>, Matchable<BaseMatcher>

Meaning: One translation into one particular language. (Its role and meaning depend on the enclosing context element.).

<!ELEMENT text (#PCDATA)* >.
Required attribute: lang.
This class realizes the element definition from the source DTD.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Element_text.Attr_lang

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
CheckedList<Element.UnmixedContent>	content List of contents elements, may freely be manipulated, as long as no null value is tried to enter.
static Element.UnmixedContent[]	EMPTY_CONTENT Constant value for convenience.
static NamespaceName	name Name of the Element is in namespace-enabled mode, namely {http://bandm.eu/doctypes/option}text.
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_text() Statically typed w.r.t. the contents; a TdomContentException can not occur.
Element_text(Attributes attrs, TypedSubstantial<Extension>... content) Semi-parsing constructor which tries to parse sequences of model content.
Element_text(Element.UnmixedContent... content) Constructor for an instance with given contents.
Element_text(String cdata) Convenience constructor which sets the contents to this one string value.
Element_text(TypedAttribute.SafeValues flag, Element.UnmixedContent... content) Constructor for an instance with given contents.
Element_text(TypedAttribute.SafeValues flag, String cdata)
Element_text(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_text	checkRequiredAttrs()
void	encode(EncodingOutputStream out, Extension ext) Abstract fall-back method which MUST be overridden and always throws an Exception.
Element_text.Attr_lang	getAttr_lang()
List<Element.UnmixedContent>	getContent() Returns the current content.
static TypedDTD.ElementInfo	getInterfaceInfo() Give reflexive info object about the generated class.
String	getPCData() Get the String contents of the TypedPCData wrapped in this content 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_text	parse(SAXEventStream in, Extension ext, TypedNode.ParseListener<Element> listener)
Element_text.Attr_lang	readAttr_lang()
void	set() Set all contents fields to a new value, after checking.
void	setContent(Element.UnmixedContent... content) Change contents to the given values.

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

content

@User
public final CheckedList<Element.UnmixedContent> content

List of contents elements, may freely be manipulated, as long as no null value is tried to enter.

EMPTY_CONTENT

@User
public static final Element.UnmixedContent[] EMPTY_CONTENT

Constant value for convenience.

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

Constructor Detail

Element_text

@User
public Element_text(Element.UnmixedContent... content)
                   throws TdomAttributeSyntaxException,
                          TdomAttributeMissingException

Constructor for an instance with given contents. Statically typed w.r.t. the contents, as far as possible. 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 lang.

Throws:

IllegalArgumentException - if any input to contents is null.

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

TdomAttributeSyntaxException

Element_text

public Element_text(TypedAttribute.SafeValues flag,
                    Element.UnmixedContent... content)
             throws TdomAttributeMissingException

Constructor for an instance with given contents. All possible attribute syntax errors must be caught locally.

Throws:

TdomAttributeMissingException

Element_text

@User
public Element_text(String cdata)
                   throws TdomAttributeSyntaxException,
                          TdomAttributeMissingException

Convenience constructor which sets the contents to this one string value. Statically typed w.r.t. the contents, as far as possible. 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 lang.

Throws:

IllegalArgumentException - if any input to contents is null.

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

TdomAttributeSyntaxException

Element_text

@User
public Element_text(TypedAttribute.SafeValues flag,
                          String cdata)
                   throws TdomAttributeMissingException

Throws:

TdomAttributeMissingException

Element_text

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

IllegalArgumentException - if any input to contents is null.

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

TdomAttributeSyntaxException

Element_text

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

Semi-parsing constructor which tries to parse sequences of model elements. Dynamically typed.
The user MUST define a subclass (mostly an anonymous one, on the fly) and override initAttrs() to set the values for the required attribute lang.

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.

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

TdomAttributeSyntaxException

Element_text

@User
public Element_text()
                   throws TdomAttributeSyntaxException,
                          TdomAttributeMissingException

Statically typed w.r.t. the contents; 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 lang.

Throws:

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

TdomAttributeSyntaxException

Method Detail

set

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

Throws:

IllegalArgumentException - if any input to contents is null.

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_lang

@User
public final Element_text.Attr_lang getAttr_lang()

Returns:

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

readAttr_lang

@User
public final Element_text.Attr_lang readAttr_lang()

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

__getAllAttrs

protected TypedAttribute[] __getAllAttrs()

Overrides:

__getAllAttrs in class TypedElement<Element,Extension>

getPCData

public String getPCData()

Description copied from interface: TypedElement.PCDataContainer

Get the String contents of the TypedPCData wrapped in this content class.

Specified by:

getPCData in interface TypedElement.PCDataContainer

Returns:

the String contents of the TypedPCData wrapped in this content class.

setContent

@User
public void setContent(Element.UnmixedContent... content)

Change contents to the given values.

Throws:

IllegalArgumentException - if a null value is found in the intended contents.

getContent

@User
public List<Element.UnmixedContent> getContent()

Returns the current content. (Gets the inner representation: changing the entries will change the model.)

Specified by:

getContent in interface TypedElement.MixedContentContainer

Returns:

(never null) the current contents.

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

Throws:

TdomAttributeMissingException

getInterfaceInfo

@User
public static TypedDTD.ElementInfo getInterfaceInfo()

Give reflexive info object about the generated class.