eu.bandm.tools.option.absy

Class Element_printout_title

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_printout_title

All Implemented Interfaces:

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

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

Meaning: The text to be printed as a header line in the "usage()" function. Can be specified for several languages.

<!ELEMENT printout_title (text)+ >.
This class realizes the element definition from the source DTD.

Nested Class Summary

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}printout_title.
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_printout_title() Statically typed w.r.t. the contents; a TdomContentException can not occur.
Element_printout_title(Attributes attrs, Element... content) Semi-parsing constructor which tries to parse sequences of model content.
Element_printout_title(Element_text... elems_1_text) Statically typed w.r.t. the contents, as far as possible.
Element_printout_title(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)
Element_printout_title	checkRequiredAttrs()
int	countElems_1_text()
void	encode(EncodingOutputStream out, Extension ext) Abstract fall-back method which MUST be overridden and always throws an Exception.
Element_text	getElem_1_text(int index)
Element_text[]	getElems_1_text()
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)
static Element_printout_title	parse(SAXEventStream in, Extension ext, TypedNode.ParseListener<Element> listener)
void	set(Element_text... elems_1_text) Set all contents fields to a new value, after checking.
Element_text	setElem_1_text(int index, Element_text newElem_1_text)
Element_text[]	setElems_1_text(Element_text... newElems_1_text)
void	visitElems_1_text(Visitor visitor) Sends the visitor to all items currently contained in the 1st appearance of Element_text 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

__getAllAttrs, classifyForException, decodeMixed, decodeOptional, decodePlus, decodePlusList, decodeStar, decodeStarList, encode, encodeMixed, end, ensureSize, extractElement, getAttrsSnapshot, getAttrsSnapshot, getElemsSnapshot, getEtherealContainer, getLocalName, getName, getNamespaceURI, getPCData, getTagName, initAttrs, 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}printout_title.

Constructor Detail

Element_printout_title

@User
public Element_printout_title(Element_text... elems_1_text)

Statically typed w.r.t. the contents, as far as possible. So a TdomContentException can not occur.

Throws:

IllegalArgumentException - if any input to contents is null.

IllegalArgumentException - if an array for a (..)+ in the content model is empty.

Element_printout_title

public Element_printout_title()

Statically typed w.r.t. the contents; a TdomContentException can not occur.

Element_printout_title

@SafeVarargs
 @User
public Element_printout_title(@Opt
                                                  Attributes attrs,
                                                  Element... content)
                                           throws TdomContentException

Semi-parsing constructor which tries to parse sequences of model content. Dynamically typed.

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.

Element_printout_title

@SafeVarargs
 @User
public Element_printout_title(Element... content)
                                           throws TdomContentException

Semi-parsing constructor which tries to parse sequences of model elements. Dynamically typed.

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.

Method Detail

set

@User
public void set(Element_text... elems_1_text)

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.

IllegalArgumentException - if an array for a (..)+ in the content model is empty.

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>

getElems_1_text

@User
public Element_text[] getElems_1_text()

Returns:

(never null) an array of all items (never null) currently contained in the 1st appearance of Element_text in the content model of this. This is directly the storage of the element's contents and all manipulations affect the element instance.

getElem_1_text

@User
public Element_text getElem_1_text(int index)

Returns:

(never null) the current value at the index position of the 1st appearance of Element_text in the content model of this.

Throws:

ArrayIndexOutOfBoundsException

countElems_1_text

public int countElems_1_text()

Returns:

the current number of items in the 1st appearance of Element_text in the content model of this.

visitElems_1_text

@User
public void visitElems_1_text(Visitor visitor)

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

setElem_1_text

@User
public Element_text setElem_1_text(int index,
                                         Element_text newElem_1_text)

Parameters:

newElem_1_text - (never null) new value at the given index position in the 1st appearance of Element_text 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.

setElems_1_text

@User
public Element_text[] setElems_1_text(Element_text... newElems_1_text)

Parameters:

newElems_1_text - (never null) an array of all values (never null) in the 1st appearance of Element_text 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 , or the array is empty.

parse

public static Element_printout_title 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>

checkRequiredAttrs

public final Element_printout_title checkRequiredAttrs()

getInterfaceInfo

@User
public static TypedDTD.ElementInfo getInterfaceInfo()

Give reflexive info object about the generated class.