org.apache.axiom.om.impl.llom

Class OMEntityReferenceImpl

java.lang.Object

org.apache.axiom.om.impl.llom.OMSerializableImpl

org.apache.axiom.om.impl.llom.OMNodeImpl

org.apache.axiom.om.impl.llom.OMLeafNode

org.apache.axiom.om.impl.llom.OMEntityReferenceImpl

All Implemented Interfaces:

IChildNode, OMNodeEx, OMEntityReference, OMInformationItem, OMNode, OMSerializable

public class OMEntityReferenceImpl
extends OMLeafNode
implements OMEntityReference

Field Summary

Fields inherited from class org.apache.axiom.om.impl.llom.OMNodeImpl

nextSibling, parent, previousSibling

Fields inherited from class org.apache.axiom.om.impl.llom.OMSerializableImpl

factory

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

Constructor Summary

Constructors

Constructor and Description
OMEntityReferenceImpl(OMContainer parent, String name, String replacementText, OMFactory factory, boolean fromBuilder)

Method Summary

Modifier and Type	Method and Description
String	getName() Get the name of the referenced entity.
String	getReplacementText() Get the replacement value for this entity reference.
int	getType() Returns the type of node.
void	internalSerialize(XMLStreamWriter writer, boolean cache) Serializes the node.

Methods inherited from class org.apache.axiom.om.impl.llom.OMLeafNode

build, discard, getBuilder, isComplete, setComplete

Methods inherited from class org.apache.axiom.om.impl.llom.OMNodeImpl

buildWithAttachments, clone, detach, getIParentNode, getNextOMSibling, getNextOMSiblingIfAvailable, getParent, getPreviousOMSibling, insertSiblingAfter, insertSiblingBefore, internalSerialize, internalSerializeAndConsume, setNextOMSibling, setParent, setPreviousOMSibling

Methods inherited from class org.apache.axiom.om.impl.llom.OMSerializableImpl

close, getOMFactory, serialize, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume

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

Constructor Detail

OMEntityReferenceImpl

public OMEntityReferenceImpl(OMContainer parent,
                             String name,
                             String replacementText,
                             OMFactory factory,
                             boolean fromBuilder)

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(XMLStreamWriter writer,
                              boolean cache)
                       throws XMLStreamException

Description copied from class: OMSerializableImpl

Serializes the node.

Specified by:

internalSerialize in interface OMNodeEx

Specified by:

internalSerialize in class OMSerializableImpl

cache - indicates if caching should be enabled

Throws:

XMLStreamException

getName

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