com.ibm.xml.dom
Class ProcessingInstructionImpl

java.lang.Object
  |
  +--com.ibm.xml.dom.NodeImpl
        |
        +--com.ibm.xml.dom.ProcessingInstructionImpl

Direct Known Subclasses:

DeferredProcessingInstructionImpl

public class ProcessingInstructionImpl

extends NodeImpl

implements ProcessingInstruction

Processing Instructions (PIs) permit documents to carry processor-specific information alongside their actual content. PIs are most common in XML, but they are supported in HTML as well.

Since:

PR-DOM-Level-1-19980818.

Version:

Revision: 68 1.5 src/com/ibm/xml/dom/ProcessingInstructionImpl.java, parser, xml4j2, xml4j2_0_15

See Also:

Serialized Form

Fields inherited from class com.ibm.xml.dom.NodeImpl

ELEMENT_DEFINITION_NODE, firstChild, kidOK, lastChild, name, nextSibling, ownerDocument, parentNode, previousSibling, readOnly, syncChildren, syncData, userData, value

Constructor Summary

ProcessingInstructionImpl(DocumentImpl ownerDoc, java.lang.String target, java.lang.String data)
Factory constructor.

Method Summary

Node	cloneNode(boolean deep) Clones this node.
java.lang.String	getData() A PI's data content tells the processor what we actually want it to do.
short	getNodeType() A short integer indicating what type of node this is.
java.lang.String	getTarget() A PI's "target" states what processor channel the PI's data should be directed to.
void	setData(java.lang.String data) Change the data content of this PI.

Methods inherited from class com.ibm.xml.dom.NodeImpl

appendChild, changed, getAttributes, getChildNodes, getFirstChild, getLastChild, getLength, getNextSibling, getNodeName, getNodeValue, getOwnerDocument, getParentNode, getPreviousSibling, getReadOnly, getUserData, hasChildNodes, insertBefore, isKidOK, item, removeChild, replaceChild, setNodeValue, setReadOnly, setUserData, synchronizeChildren, synchronizeData, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessingInstructionImpl

public ProcessingInstructionImpl(DocumentImpl ownerDoc,
                                 java.lang.String target,
                                 java.lang.String data)

Factory constructor.

Method Detail

getNodeType

public short getNodeType()

A short integer indicating what type of node this is. The named constants for this value are defined in the org.w3c.dom.Node interface.

Overrides:

getNodeType in class NodeImpl

cloneNode

public Node cloneNode(boolean deep)

Clones this node.

Overrides:

cloneNode in class NodeImpl

getTarget

public java.lang.String getTarget()

A PI's "target" states what processor channel the PI's data should be directed to. It is defined differently in HTML and XML.

In XML, a PI's "target" is the first (whitespace-delimited) token following the " In HTML, target is always null.

Note that getNodeName is aliased to getTarget.

Specified by:

getTarget in interface ProcessingInstruction

getData

public java.lang.String getData()

A PI's data content tells the processor what we actually want it to do. It is defined slightly differently in HTML and XML.

In XML, the data begins with the non-whitespace character immediately after the target -- @see getTarget().

In HTML, the data begins with the character immediately after the "<?" token that begins the PI.

Note that getNodeValue is aliased to getData

Specified by:

getData in interface ProcessingInstruction

setData

public void setData(java.lang.String data)

Change the data content of this PI. Note that setNodeValue is aliased to setData

Specified by:

setData in interface ProcessingInstruction

Throws:

DOMException(NO_MODIFICATION_ALLOWED_ERR) - if node is read-only.

See Also:

getData().