com.sun.xml.txw2

Class ContainerElement

java.lang.Object

com.sun.xml.txw2.ContainerElement

All Implemented Interfaces:

TypedXmlWriter, java.lang.reflect.InvocationHandler

final class ContainerElement
extends java.lang.Object
implements java.lang.reflect.InvocationHandler, TypedXmlWriter

Dynamically implements TypedXmlWriter interfaces.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	blocked Set to true if the start eleent is blocked.
(package private) Document	document
(package private) EndTag	endTag
private ContainerElement	lastOpenChild
private ContainerElement	nextOpen
private java.lang.String	nsUri Namespace URI of this element.
private ContainerElement	parent
private ContainerElement	prevOpen Uncommitted ContainerElements form a doubly-linked list, so that the parent can close them recursively.
(package private) StartTag	startTag Initially, point to the start tag token, but once we know we are done with the start tag, we will reset it to null so that the token sequence can be GC-ed.
private Content	tail When this element can accept more child content, this value is non-null and holds the last child Content.

Constructor Summary

Constructors

Constructor and Description
ContainerElement(Document document, ContainerElement parent, java.lang.String nsUri, java.lang.String localName)

Method Summary

Modifier and Type	Method and Description
void	_attribute(javax.xml.namespace.QName attributeName, java.lang.Object value) Adds an attribute of the given name and the value.
void	_attribute(java.lang.String localName, java.lang.Object value) Adds an attribute of the given name and the value.
void	_attribute(java.lang.String nsUri, java.lang.String localName, java.lang.Object value) Adds an attribute of the given name and the value.
<T extends TypedXmlWriter> T	_cast(java.lang.Class<T> facadeType) Returns a different interface for this typed XML Writer.
void	_cdata(java.lang.Object value) Appends CDATA section.
void	_comment(java.lang.Object value) Appends a comment.
private void	_commit(boolean includingAllPredecessors)
<T extends TypedXmlWriter> T	_element(java.lang.Class<T> contentModel) Appends a new child element.
<T extends TypedXmlWriter> T	_element(javax.xml.namespace.QName tagName, java.lang.Class<T> contentModel) Appends a new child element.
<T extends TypedXmlWriter> T	_element(java.lang.String localName, java.lang.Class<T> contentModel) Appends a new child element.
<T extends TypedXmlWriter> T	_element(java.lang.String nsUri, java.lang.String localName, java.lang.Class<T> contentModel) Appends a new child element.
void	_namespace(java.lang.String uri) Declares a new namespace URI on this element.
void	_namespace(java.lang.String uri, boolean requirePrefix) Declares a new namespace URI on this element.
void	_namespace(java.lang.String uri, java.lang.String prefix) Declares a new namespace URI on this element to a specific prefix.
void	_pcdata(java.lang.Object value) Appends text data.
private void	addAttribute(XmlAttribute xa, java.lang.reflect.Method method, java.lang.Object[] args) Writes an attribute.
private void	addChild(Content child) Appends this child object to the tail.
private java.lang.Object	addElement(XmlElement e, java.lang.reflect.Method method, java.lang.Object[] args) Writes a new element.
void	block() Blocks the writing of the start tag so that new attributes can be added even after child elements are appended.
private void	checkStartTag()
void	commit() Commits this element (and all its descendants) to the output.
void	commit(boolean includingAllPredecessors) Commits this element (and all its descendants) to the output.
Document	getDocument() Gets the Document object that this writer is writing to.
private java.lang.String	getNamespace(java.lang.Package pkg) Decides the namespace URI of the given package.
java.lang.Object	invoke(java.lang.Object proxy, java.lang.reflect.Method method, java.lang.Object[] args)
(package private) boolean	isBlocked()
private boolean	isCommitted()
private boolean	isRoot()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

document

final Document document

startTag

StartTag startTag

Initially, point to the start tag token, but once we know we are done with the start tag, we will reset it to null so that the token sequence can be GC-ed.

endTag

final EndTag endTag

nsUri

private final java.lang.String nsUri

Namespace URI of this element.

tail

private Content tail

When this element can accept more child content, this value is non-null and holds the last child Content. If this element is committed, this parameter is null.

prevOpen

private ContainerElement prevOpen

Uncommitted ContainerElements form a doubly-linked list, so that the parent can close them recursively.

nextOpen

private ContainerElement nextOpen

parent

private final ContainerElement parent

lastOpenChild

private ContainerElement lastOpenChild

blocked

private boolean blocked

Set to true if the start eleent is blocked.

Constructor Detail

ContainerElement

public ContainerElement(Document document,
                        ContainerElement parent,
                        java.lang.String nsUri,
                        java.lang.String localName)

Method Detail

isRoot

private boolean isRoot()

isCommitted

private boolean isCommitted()

getDocument

public Document getDocument()

Description copied from interface: TypedXmlWriter

Gets the Document object that this writer is writing to.

Specified by:

getDocument in interface TypedXmlWriter

Returns:

always non-null.

isBlocked

boolean isBlocked()

block

public void block()

Description copied from interface: TypedXmlWriter

Blocks the writing of the start tag so that new attributes can be added even after child elements are appended.

This blocks the output at the token before the start tag until the TypedXmlWriter.commit() method is called to _commit this element.

For more information, see the TXW documentation.

Specified by:

block in interface TypedXmlWriter

invoke

public java.lang.Object invoke(java.lang.Object proxy,
                               java.lang.reflect.Method method,
                               java.lang.Object[] args)
                        throws java.lang.Throwable

Specified by:

invoke in interface java.lang.reflect.InvocationHandler

Throws:

java.lang.Throwable

addAttribute

private void addAttribute(XmlAttribute xa,
                          java.lang.reflect.Method method,
                          java.lang.Object[] args)

Writes an attribute.

checkStartTag

private void checkStartTag()

addElement

private java.lang.Object addElement(XmlElement e,
                                    java.lang.reflect.Method method,
                                    java.lang.Object[] args)

Writes a new element.

getNamespace

private java.lang.String getNamespace(java.lang.Package pkg)

Decides the namespace URI of the given package.

addChild

private void addChild(Content child)

Appends this child object to the tail.

commit

public void commit()

Description copied from interface: TypedXmlWriter

Commits this element (and all its descendants) to the output.

Short for _commit(true).

Specified by:

commit in interface TypedXmlWriter

commit

public void commit(boolean includingAllPredecessors)

Description copied from interface: TypedXmlWriter

Commits this element (and all its descendants) to the output.

Once a writer is committed, nothing can be added to it further. Committing allows TXW to output a part of the document even if the rest has not yet been written.

Specified by:

commit in interface TypedXmlWriter

Parameters:

includingAllPredecessors - if false, this operation will _commit this writer and all its descendants writers. If true, in addition to those writers, this operation will close all the writers before this writer in the document order.

_commit

private void _commit(boolean includingAllPredecessors)

_attribute

public void _attribute(java.lang.String localName,
                       java.lang.Object value)

Description copied from interface: TypedXmlWriter

Adds an attribute of the given name and the value.

Short for

_attribute("",localName,value);

Specified by:

_attribute in interface TypedXmlWriter

See Also:

TypedXmlWriter._attribute(String, String, Object)

_attribute

public void _attribute(java.lang.String nsUri,
                       java.lang.String localName,
                       java.lang.Object value)

Description copied from interface: TypedXmlWriter

Adds an attribute of the given name and the value.

Short for

_attribute(new QName(nsUri,localName),value);

Specified by:

_attribute in interface TypedXmlWriter

See Also:

TypedXmlWriter._attribute(QName, Object)

_attribute

public void _attribute(javax.xml.namespace.QName attributeName,
                       java.lang.Object value)

Description copied from interface: TypedXmlWriter

Adds an attribute of the given name and the value.

Specified by:

_attribute in interface TypedXmlWriter

Parameters:

attributeName - must not be null.

value - value of the attribute. must not be null. See the documentation for the conversion rules.

_namespace

public void _namespace(java.lang.String uri)

Description copied from interface: TypedXmlWriter

Declares a new namespace URI on this element.

The runtime system will assign an unique prefix for the URI.

Specified by:

_namespace in interface TypedXmlWriter

Parameters:

uri - can be empty, but must not be null.

_namespace

public void _namespace(java.lang.String uri,
                       java.lang.String prefix)

Description copied from interface: TypedXmlWriter

Declares a new namespace URI on this element to a specific prefix.

Specified by:

_namespace in interface TypedXmlWriter

Parameters:

uri - can be empty, but must not be null.

prefix - If non-empty, this prefix is bound to the URI on this element. If empty, then the runtime will still try to use the URI as the default namespace, but it may fail to do so because of the constraints in the XML.

_namespace

public void _namespace(java.lang.String uri,
                       boolean requirePrefix)

Description copied from interface: TypedXmlWriter

Declares a new namespace URI on this element.

The runtime system will assign an unique prefix for the URI.

Specified by:

_namespace in interface TypedXmlWriter

Parameters:

uri - can be empty, but must not be null.

requirePrefix - if false, this method behaves just like TypedXmlWriter._namespace(String). if true, this guarantees that the URI is bound to a non empty prefix.

_pcdata

public void _pcdata(java.lang.Object value)

Description copied from interface: TypedXmlWriter

Appends text data.

Specified by:

_pcdata in interface TypedXmlWriter

Parameters:

value - must not be null. See the documentation for the conversion rules.

_cdata

public void _cdata(java.lang.Object value)

Description copied from interface: TypedXmlWriter

Appends CDATA section.

Specified by:

_cdata in interface TypedXmlWriter

Parameters:

value - must not be null. See the documentation for the conversion rules.

_comment

public void _comment(java.lang.Object value)
              throws java.lang.UnsupportedOperationException

Description copied from interface: TypedXmlWriter

Appends a comment.

Specified by:

_comment in interface TypedXmlWriter

Parameters:

value - must not be null. See the documentation for the conversion rules.

Throws:

java.lang.UnsupportedOperationException - if the underlying XmlSerializer does not support writing comments, this exception can be thrown.

_element

public <T extends TypedXmlWriter> T _element(java.lang.String localName,
                                             java.lang.Class<T> contentModel)

Description copied from interface: TypedXmlWriter

Appends a new child element.

Short for

_element(URI of this element,localName,contentModel);

The namespace URI will be inherited from the parent element.

Specified by:

_element in interface TypedXmlWriter

See Also:

TypedXmlWriter._element(String, String, Class)

_element

public <T extends TypedXmlWriter> T _element(javax.xml.namespace.QName tagName,
                                             java.lang.Class<T> contentModel)

Description copied from interface: TypedXmlWriter

Appends a new child element.

Short for

_element(tagName.getNamespaceURI(),tagName.getLocalPart(),contentModel);

Specified by:

_element in interface TypedXmlWriter

See Also:

TypedXmlWriter._element(String, String, Class)

_element

public <T extends TypedXmlWriter> T _element(java.lang.Class<T> contentModel)

Description copied from interface: TypedXmlWriter

Appends a new child element.

This version of the _element method requires the T class to be annotated with XmlElement annotation. The element name will be taken from there.

Specified by:

_element in interface TypedXmlWriter

See Also:

TypedXmlWriter._element(String, String, Class)

_cast

public <T extends TypedXmlWriter> T _cast(java.lang.Class<T> facadeType)

Description copied from interface: TypedXmlWriter

Returns a different interface for this typed XML Writer.

Semantically, this operation is a 'cast' --- it returns the same underlying writer in a different interface. The returned new writer and the current writer will write to the same element.

But this is different from Java's ordinary cast because the returned object is not always the same as the current object.

Specified by:

_cast in interface TypedXmlWriter

Returns:

always return non-null.

_element

public <T extends TypedXmlWriter> T _element(java.lang.String nsUri,
                                             java.lang.String localName,
                                             java.lang.Class<T> contentModel)

Description copied from interface: TypedXmlWriter

Appends a new child element.

The newly created child element is appended at the end of the children.

Specified by:

_element in interface TypedXmlWriter

Parameters:

nsUri - The namespace URI of the newly created element.

localName - The local name of the newly created element.

contentModel - The typed XML writer interface used to write the children of the new child element.

Returns:

always return non-null TypedXmlWriter that can be used to write the contents of the newly created child element.