eu.bandm.tools.tdom.runtime

Class CDataAttribute

java.lang.Object

eu.bandm.tools.tdom.runtime.TypedNode<TypedExtension>

eu.bandm.tools.tdom.runtime.TypedAttribute<String>

eu.bandm.tools.tdom.runtime.CDataAttribute

Direct Known Subclasses:

Attr_accesskey, Attr_char, Attr_charoff, Attr_charset, Attr_class, Attr_href, Attr_name, Attr_onblur, Attr_onclick, Attr_ondblclick, Attr_onfocus, Attr_onkeydown, Attr_onkeypress, Attr_onkeyup, Attr_onmousedown, Attr_onmousemove, Attr_onmouseout, Attr_onmouseover, Attr_onmouseup, Attr_rel, Attr_rev, Attr_style, Attr_tabindex, Attr_title, Attr_type, Element_a_footnote.Attr_a_symbol, Element_a_footnote.Attr_xml_lang, Element_a_footnotemark.Attr_a_symbol, Element_a_footnotetext.Attr_a_symbol, Element_a_footnotetext.Attr_xml_lang, Element_a_p.Attr_xml_lang, Element_a_spanstyle.Attr_a_style, Element_a_xlang.Attr_xml_lang, Element_a.Attr_coords, Element_area.Attr_alt, Element_area.Attr_coords, Element_base.Attr_href, Element_blockquote.Attr_cite, Element_body.Attr_onload, Element_body.Attr_onunload, Element_button.Attr_value, Element_col.Attr_span, Element_col.Attr_width, Element_colgroup.Attr_span, Element_colgroup.Attr_width, Element_constant.Attr_value, Element_del.Attr_cite, Element_del.Attr_datetime, Element_desc.Attr_xml_lang, Element_entry.Attr_key, Element_enumitem.Attr_value, Element_form.Attr_accept, Element_form.Attr_accept_charset, Element_form.Attr_action, Element_form.Attr_enctype, Element_form.Attr_onreset, Element_form.Attr_onsubmit, Element_head.Attr_profile, Element_html.Attr_xmlns, Element_img.Attr_alt, Element_img.Attr_height, Element_img.Attr_longdesc, Element_img.Attr_src, Element_img.Attr_usemap, Element_img.Attr_width, Element_input.Attr_accept, Element_input.Attr_alt, Element_input.Attr_maxlength, Element_input.Attr_onchange, Element_input.Attr_onselect, Element_input.Attr_size, Element_input.Attr_src, Element_input.Attr_usemap, Element_input.Attr_value, Element_ins.Attr_cite, Element_ins.Attr_datetime, Element_link.Attr_media, Element_meta.Attr_content, Element_meta.Attr_http_equiv, Element_meta.Attr_scheme, Element_object.Attr_archive, Element_object.Attr_classid, Element_object.Attr_codebase, Element_object.Attr_codetype, Element_object.Attr_data, Element_object.Attr_height, Element_object.Attr_standby, Element_object.Attr_usemap, Element_object.Attr_width, Element_optgroup.Attr_label, Element_option.Attr_label, Element_option.Attr_value, Element_param.Attr_value, Element_q.Attr_cite, Element_rat.Attr_default, Element_script.Attr_src, Element_script.Attr_type, Element_select.Attr_onchange, Element_select.Attr_size, Element_string.Attr_default, Element_style.Attr_media, Element_style.Attr_type, Element_table.Attr_border, Element_table.Attr_cellpadding, Element_table.Attr_cellspacing, Element_table.Attr_summary, Element_table.Attr_width, Element_td.Attr_abbr, Element_td.Attr_axis, Element_td.Attr_colspan, Element_td.Attr_rowspan, Element_textarea.Attr_cols, Element_textarea.Attr_onchange, Element_textarea.Attr_onselect, Element_textarea.Attr_rows, Element_th.Attr_abbr, Element_th.Attr_axis, Element_th.Attr_colspan, Element_th.Attr_rowspan, Element_uri.Attr_default

@User
public abstract class CDataAttribute
extends TypedAttribute<String>

Base class for all generated classes which realize an Attribute with type CDATA. This declaration means an attribute with an arbitrary character sequence as its value, and no further structure imposed. As a consequence, the value type parameter for these attributes is String, and an TdomAttributeSyntaxException is only thrown when an attribute is absent (null) and #REQUIRED.

Nested Class Summary

Nested classes/interfaces inherited from class eu.bandm.tools.tdom.runtime.TypedAttribute

TypedAttribute.__PreAtts, TypedAttribute.SafeValues

Nested classes/interfaces inherited from class eu.bandm.tools.tdom.runtime.TypedNode

TypedNode.ParseListener<E extends TypedElement<?,?>>

Field Summary

Fields inherited from class eu.bandm.tools.tdom.runtime.TypedAttribute

__preAtts, emptyAttributes, mutable, safeValues, specified, value

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CDataAttribute()
protected	CDataAttribute(@Opt String value)
protected	CDataAttribute(TypedAttribute.SafeValues flag, @Opt String value) This variant may only be invoked by generated code if value argument is known to be != null.

Method Summary

Modifier and Type	Method and Description
protected void	checkValue(@Opt String value) Check routine for the validity of the attributes' intended value.
void	encode(EncodingOutputStream out, TypedExtension ext) Abstract fall-back method which MUST be overridden and always throws an Exception.
String	getStringValue(String s) Returns the textual representation of a possible attribute value (not null), as it would be contained literally in a possible XML text representation.
String	getTypeString() The definition text for the "type" of the attribute in the original DTD.
void	setValue(@Opt String newValue, TypedAttribute.SafeValues flag) Internal use only.

Methods inherited from class eu.bandm.tools.tdom.runtime.TypedAttribute

assertSetAttrValid, checkRequired, clearValue, find, find, getDefaultValue, getLocalName, getNamespaceName, getNamespaceURI, getStringValue, getTagName, getValue, isFixed, isOptional, isRequired, isSpecified, makeUnspecified, put, setValue

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, encode, 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

Constructor Detail

CDataAttribute

protected CDataAttribute()

CDataAttribute

protected CDataAttribute(@Opt
                         @Opt String value)
                  throws TdomAttributeSyntaxException

Throws:

TdomAttributeSyntaxException

CDataAttribute

protected CDataAttribute(TypedAttribute.SafeValues flag,
                         @Opt
                         @Opt String value)

This variant may only be invoked by generated code if value argument is known to be != null. In this case no TdomAttributeSyntaxException can be thrown, because String values are permitted.

Method Detail

checkValue

protected void checkValue(@Opt
                          @Opt String value)

Description copied from class: TypedAttribute

Check routine for the validity of the attributes' intended value. Is a call-back, implemented by the sub-classes. Is called only here, by two constructors and the #set_value(V) method. The value null means "absent" for #IMPLIED attributes and passes the test.

Specified by:

checkValue in class TypedAttribute<String>

Parameters:

value - the value to test; maybe null.

getTypeString

public String getTypeString()

Description copied from class: TypedAttribute

The definition text for the "type" of the attribute in the original DTD.

Specified by:

getTypeString in class TypedAttribute<String>

setValue

public void setValue(@Opt
                     @Opt String newValue,
                     TypedAttribute.SafeValues flag)

Internal use only. Is called by a generated setValue(@Opt String) method iff attribute is #IMPLIED, because then never a exception will be thrown.

encode

public final void encode(EncodingOutputStream out,
                         TypedExtension 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<TypedExtension>

Throws:

IOException

getStringValue

public final String getStringValue(String s)

Description copied from class: TypedAttribute

Returns the textual representation of a possible attribute value (not null), as it would be contained literally in a possible XML text representation. Since the textual representation of a String is the string itself, this method is relevant for enumeration types only (Later: also for "entity" types, but these are not yet supported.)

Specified by:

getStringValue in class TypedAttribute<String>

Returns:

(never null) the textual representation of this attribute value, as it would be contained literally in a possible XML text representation.