org.openxml.dom

Class ElementDeclImpl

java.lang.Object

org.openxml.dom.NodeImpl

org.openxml.dom.ElementDeclImpl

All Implemented Interfaces:

Cloneable, Node

public class ElementDeclImpl
extends NodeImpl
implements Node

Author:

Assaf Arkin

See Also:

Node, NodeImpl

Field Summary

Fields inherited from class org.openxml.dom.NodeImpl

ATTLIST_DECL_NODE, ELEMENT_DECL_NODE, PARAM_ENTITY_NODE

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Method Summary

Modifier and Type	Method and Description
Object	clone()
Node	cloneNode(boolean deep)
short	compareDocumentPosition(Node other)
boolean	equals(Object other) Returns true if this node and other are identical by content but not context.
String	getBaseURI()
Object	getFeature(String feature, String version)
String	getName()
short	getNodeType() Abstract method must be implemented by each node class.
String	getTextContent()
Object	getUserData(String key)
boolean	hasAttributes()
boolean	isAny() Returns true if element may contain any child elements and character data in any order.
boolean	isDefaultNamespace(String namespaceURI)
boolean	isEmpty() Returns true if element is empty.
boolean	isEqualNode(Node arg)
boolean	isMixed() Returns true if element contains mixed contents.
boolean	isSameNode(Node other)
boolean	isSupported(String feature, String version)
String	lookupNamespaceURI(String prefix)
String	lookupPrefix(String namespaceURI)
boolean	requiresClosingTag() Returns true if the closing tag is optional.
boolean	requiresOpeningTag() Returns true if the opening tag is optional.
void	setTextContent(String textContent)
Object	setUserData(String key, Object data, UserDataHandler handler)

Methods inherited from class org.openxml.dom.NodeImpl

appendChild, cloneInto, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, hasChildNodes, insertBefore, isReadOnly, makeReadOnly, normalize, removeChild, replaceChild, setNodeValue, setOwnerDocument, setPrefix, supports

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.w3c.dom.Node

appendChild, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, hasChildNodes, insertBefore, normalize, removeChild, replaceChild, setNodeValue, setPrefix

Method Detail

getNodeType

public short getNodeType()

Description copied from class: NodeImpl

Abstract method must be implemented by each node class.

Specified by:

getNodeType in interface Node

Specified by:

getNodeType in class NodeImpl

See Also:

Node.getNodeType()

getName

public String getName()

equals

public boolean equals(Object other)

Description copied from class: NodeImpl

Returns true if this node and other are identical by content but not context. Test by content but not context adheres to the following:

• Both nodes must be of the same type, must have the same name and value (case sensitive) and for elements, the same tag name
• For elements, both must have identical attribute list, although attributes may be specified/unspecified and in different orders
• Both nodes must have no children, or must have the exact same sequence of children; children are tested for equality by calling NodeImpl.equals(java.lang.Object) on each pair
• However, both nodes may reside in different documents, belong to different parents, have different siblings, different read-only flags, etc.

It is guaranteed that the act of cloning a node will return a second node that will pass the test of equality.

Note that for large document roots, the equality operation can be very expensive.

Overrides:

equals in class NodeImpl

Parameters:

other - The other node to test for equality

Returns:

True if both nodes are equal based on their content but not their context

isEmpty

public boolean isEmpty()

Returns true if element is empty. An empty element cannot contain any children and must be specified with an empty tag, or an opening tag immediately followed by a closing tag.

Returns:

True if element is empty

isAny

public boolean isAny()

Returns true if element may contain any child elements and character data in any order.

Returns:

True if element supports any contents

isMixed

public boolean isMixed()

Returns true if element contains mixed contents. Mixed contents includes both elements and character data in any particular order. This option implies that both isEmpty() and isAny() return false. If all three are false, then contents is subject to exact order.

Returns:

True if element contains mixed contents

requiresOpeningTag

public boolean requiresOpeningTag()

Returns true if the opening tag is optional. Even if the opening tag is missing from the document for this element, the document is still valid. This option only relates to HTML document, and implies that requiresClosingTag() is also true.

Returns:

True if opening tag is optional

requiresClosingTag

public boolean requiresClosingTag()

Returns true if the closing tag is optional. Even if the closing tag is missing from the document for this element, the document is still valid. This option only relates to HTML document.

Returns:

True if closing tag is optional

clone

public final Object clone()

Overrides:

clone in class Object

cloneNode

public final Node cloneNode(boolean deep)

Specified by:

cloneNode in interface Node

compareDocumentPosition

public short compareDocumentPosition(Node other)
                              throws DOMException

Specified by:

compareDocumentPosition in interface Node

Throws:

DOMException

getBaseURI

public String getBaseURI()

Specified by:

getBaseURI in interface Node

getFeature

public Object getFeature(String feature,
                         String version)

Specified by:

getFeature in interface Node

getTextContent

public String getTextContent()
                      throws DOMException

Specified by:

getTextContent in interface Node

Throws:

DOMException

getUserData

public Object getUserData(String key)

Specified by:

getUserData in interface Node

isDefaultNamespace

public boolean isDefaultNamespace(String namespaceURI)

Specified by:

isDefaultNamespace in interface Node

isEqualNode

public boolean isEqualNode(Node arg)

Specified by:

isEqualNode in interface Node

isSameNode

public boolean isSameNode(Node other)

Specified by:

isSameNode in interface Node

lookupNamespaceURI

public String lookupNamespaceURI(String prefix)

Specified by:

lookupNamespaceURI in interface Node

lookupPrefix

public String lookupPrefix(String namespaceURI)

Specified by:

lookupPrefix in interface Node

setTextContent

public void setTextContent(String textContent)
                    throws DOMException

Specified by:

setTextContent in interface Node

Throws:

DOMException

setUserData

public Object setUserData(String key,
                          Object data,
                          UserDataHandler handler)

Specified by:

setUserData in interface Node

hasAttributes

public boolean hasAttributes()

Specified by:

hasAttributes in interface Node

isSupported

public boolean isSupported(String feature,
                           String version)

Specified by:

isSupported in interface Node