org.apache.axiom.om.impl.dom

Class EntityReferenceImpl

java.lang.Object

org.apache.axiom.om.impl.dom.NodeImpl

org.apache.axiom.om.impl.dom.LeafNode

org.apache.axiom.om.impl.dom.EntityReferenceImpl

All Implemented Interfaces:

IChildNode, OMNodeEx, OMEntityReference, OMInformationItem, OMNode, OMSerializable, org.w3c.dom.EntityReference, org.w3c.dom.Node

public class EntityReferenceImpl
extends LeafNode
implements OMEntityReference, org.w3c.dom.EntityReference

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	name
private java.lang.String	replacementText

Fields inherited from class org.apache.axiom.om.impl.dom.NodeImpl

factory, FIRSTCHILD, flags, HAS_PARENT, SPECIFIED

Fields inherited from interface org.apache.axiom.om.OMNode

CDATA_SECTION_NODE, COMMENT_NODE, DTD_NODE, ELEMENT_NODE, ENTITY_REFERENCE_NODE, PI_NODE, SPACE_NODE, TEXT_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

Constructor Summary

Constructors

Constructor and Description
EntityReferenceImpl(java.lang.String name, java.lang.String replacementText, OMFactory factory)

Method Summary

Modifier and Type	Method and Description
(package private) LeafNode	createClone()
java.lang.String	getName() Get the name of the referenced entity.
java.lang.String	getNodeName()
short	getNodeType()
java.lang.String	getReplacementText() Get the replacement value for this entity reference.
int	getType() Returns the type of node.
void	internalSerialize(javax.xml.stream.XMLStreamWriter writer, boolean cache) Serializes the node.

Methods inherited from class org.apache.axiom.om.impl.dom.LeafNode

appendChild, beforeClone, build, clone, discard, getBuilder, getChildNodes, getIParentNode, getNextOMSibling, getNextSibling, insertBefore, internalGetNextSibling, internalGetOwnerNode, internalGetPreviousSibling, internalSetNextSibling, internalSetOwnerNode, internalSetPreviousSibling, isComplete, lookupNamespaceURI, removeChild, replaceChild, setComplete

Methods inherited from class org.apache.axiom.om.impl.dom.NodeImpl

buildWithAttachments, checkSameOwnerDocument, clone, cloneNode, close, compareDocumentPosition, detach, detach, getAttributes, getBaseURI, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextOMSiblingIfAvailable, getNodeValue, getOMFactory, getOwnerDocument, getParent, getParentNode, getPrefix, getPreviousOMSibling, getPreviousSibling, getTextContent, getTextContent, getUserData, hasAttributes, hasChildNodes, hasParent, hasParent, insertSiblingAfter, insertSiblingBefore, internalSerialize, internalSerializeAndConsume, isDefaultNamespace, isEqualNode, isFirstChild, isFirstChild, isSameNode, isSpecified, isSpecified, isSupported, lookupPrefix, normalize, normalize, ownerDocument, parentNode, serialize, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, setNextOMSibling, setNodeValue, setOwnerDocument, setParent, setParent, setPrefix, setPreviousOMSibling, setTextContent, setUserData

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.axiom.om.OMNode

buildWithAttachments, detach, discard, getNextOMSibling, getParent, getPreviousOMSibling, insertSiblingAfter, insertSiblingBefore, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume

Methods inherited from interface org.apache.axiom.om.OMSerializable

build, close, isComplete, serialize, serialize, serializeAndConsume

Methods inherited from interface org.apache.axiom.om.OMInformationItem

clone, getOMFactory

Methods inherited from interface org.w3c.dom.Node

appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData

Methods inherited from interface org.apache.axiom.om.impl.OMNodeEx

getNextOMSiblingIfAvailable, internalSerialize, internalSerializeAndConsume, setNextOMSibling, setParent, setPreviousOMSibling

Field Detail

name

private final java.lang.String name

replacementText

private final java.lang.String replacementText

Constructor Detail

EntityReferenceImpl

public EntityReferenceImpl(java.lang.String name,
                           java.lang.String replacementText,
                           OMFactory factory)

Method Detail

getType

public int getType()

Description copied from interface: OMNode

Returns the type of node.

Specified by:

getType in interface OMNode

Returns:

Returns one of OMNode.ELEMENT_NODE, OMNode.TEXT_NODE, OMNode.CDATA_SECTION_NODE, OMNode.COMMENT_NODE, OMNode.DTD_NODE, OMNode.PI_NODE, OMNode.ENTITY_REFERENCE_NODE or OMNode.SPACE_NODE.

internalSerialize

public void internalSerialize(javax.xml.stream.XMLStreamWriter writer,
                              boolean cache)
                       throws javax.xml.stream.XMLStreamException

Description copied from interface: OMNodeEx

Serializes the node. Note that this is an internal method that MUST NOT be used outside of Axiom. Please use OMSerializable.serialize(XMLStreamWriter, boolean) instead.

Specified by:

internalSerialize in interface OMNodeEx

Specified by:

internalSerialize in class NodeImpl

cache - indicates if caching should be enabled

Throws:

javax.xml.stream.XMLStreamException

getName

public java.lang.String getName()

Description copied from interface: OMEntityReference

Get the name of the referenced entity.

Specified by:

getName in interface OMEntityReference

Returns:

the name of the entity

getReplacementText

public java.lang.String getReplacementText()

Description copied from interface: OMEntityReference

Get the replacement value for this entity reference. Note that the replacement value is a simple string and may therefore contain unparsed markup.

Specified by:

getReplacementText in interface OMEntityReference

Returns:

the replacement value, or null if the replacement value is not available

createClone

LeafNode createClone()

Specified by:

createClone in class LeafNode

getNodeName

public java.lang.String getNodeName()

Specified by:

getNodeName in interface org.w3c.dom.Node

getNodeType

public short getNodeType()

Specified by:

getNodeType in interface org.w3c.dom.Node