public class

ProcessingInstructionImpl

extends CharacterDataImpl
implements ProcessingInstruction

java.lang.Object
↳	org.apache.xerces.dom.NodeImpl
	↳	org.apache.xerces.dom.ChildNode
		↳	org.apache.xerces.dom.CharacterDataImpl
			↳	org.apache.xerces.dom.ProcessingInstructionImpl

Known Direct Subclasses

DeferredProcessingInstructionImpl

Class Overview

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. This class inherits from CharacterDataImpl to reuse its setNodeValue method.@xerces.internal

Summary

[Expand]

Inherited Constants

From class org.apache.xerces.dom.NodeImpl

From interface org.w3c.dom.Node

Fields
protected String	target

[Expand]

Inherited Fields

From class org.apache.xerces.dom.CharacterDataImpl

From class org.apache.xerces.dom.ChildNode

From class org.apache.xerces.dom.NodeImpl

Public Constructors
	ProcessingInstructionImpl(CoreDocumentImpl ownerDoc, String target, String data) Factory constructor.

Public Methods
String	getBaseURI() Returns the absolute base URI of this node or null if the implementation wasn't able to obtain an absolute URI.
String	getData() A PI's data content tells the processor what we actually want it to do.
String	getNodeName() Returns the target
short	getNodeType() A short integer indicating what type of node this is.
String	getTarget() A PI's "target" states what processor channel the PI's data should be directed to.
void	setData(String data) Change the data content of this PI.

[Expand]

Inherited Methods

From class org.apache.xerces.dom.CharacterDataImpl

void	appendData(String data) Concatenate additional characters onto the end of the data stored in this node.
void	deleteData(int offset, int count) Remove a range of characters from the node's value.
NodeList	getChildNodes() Returns an empty node list.
String	getData() Retrieve character data currently stored in this node.
int	getLength() Report number of characters currently stored in this node's data.
String	getNodeValue() Returns the node value.
void	insertData(int offset, String data) Insert additional characters into the data stored in this node, at the offset specified.
void	replaceData(int offset, int count, String data) Replace a series of characters at the specified (zero-based) offset with a new string, NOT necessarily of the same length.
void	setData(String value) Store character data into this node.
void	setNodeValue(String value) Sets the content, possibly firing related events, and updating ranges (via notification to the document)
void	setNodeValueInternal(String value) Convenience wrapper for calling setNodeValueInternal when we are not performing a replacement operation
void	setNodeValueInternal(String value, boolean replace) This function added so that we can distinguish whether setNodeValue has been called from some other DOM functions.
String	substringData(int offset, int count) Substring is more than a convenience function.

From class org.apache.xerces.dom.ChildNode

From class org.apache.xerces.dom.NodeImpl

void	addEventListener(String type, EventListener listener, boolean useCapture)
Node	appendChild(Node newChild) Adds a child node to the end of the list of children for this node.
void	changed() Denotes that this node has changed.
int	changes() Returns the number of changes to this node.
Node	cloneNode(boolean deep) Returns a duplicate of a given node.
short	compareDocumentPosition(Node other) Compares a node with this node with regard to their position in the document.
short	compareTreePosition(Node other) This method is deprecated. No replacement.
boolean	dispatchEvent(Event event)
NamedNodeMap	getAttributes() Return the collection of attributes associated with this node, or null if none.
String	getBaseURI() The absolute base URI of this node or `null` if undefined.
NodeList	getChildNodes() Obtain a NodeList enumerating all children of this node.
Node	getContainer() For non-child nodes, the node which "points" to this node.
Object	getFeature(String feature, String version)
Node	getFirstChild() The first child of this Node, or null if none.
Node	getLastChild() The first child of this Node, or null if none.
int	getLength() NodeList method: Count the immediate children of this node By default we do not have any children, ParentNode overrides this.
String	getLocalName() Introduced in DOM Level 2.
String	getNamespaceURI() Introduced in DOM Level 2.
Node	getNextSibling() The next child of this node's parent, or null if none
abstract String	getNodeName() the name of this node.
int	getNodeNumber() Returns the node number
abstract short	getNodeType() A short integer indicating what type of node this is.
String	getNodeValue() Returns the node value.
Document	getOwnerDocument() Find the Document that this Node belongs to (the document in whose context the Node was created).
Node	getParentNode() Obtain the DOM-tree parent of this node, or null if it is not currently active in the DOM tree (perhaps because it has just been created or removed).
String	getPrefix() Introduced in DOM Level 2.
Node	getPreviousSibling() The previous child of this node's parent, or null if none
boolean	getReadOnly() NON-DOM: Returns true if this node is read-only.
String	getTextContent() This attribute returns the text content of this node and its descendants.
Object	getUserData() NON-DOM: Returns the user data associated to this node.
Object	getUserData(String key) Retrieves the object associated to a key on a this node.
Hashtable	getUserDataRecord()
boolean	hasAttributes() Returns whether this node (if it is an element) has any attributes.
boolean	hasChildNodes() Test whether this node has any children.
Node	insertBefore(Node newChild, Node refChild) Move one or more node(s) to our list of children.
boolean	isDefaultNamespace(String namespaceURI) DOM Level 3: Experimental This method checks if the specified `namespaceURI` is the default namespace or not.
boolean	isEqualNode(Node arg) Tests whether two nodes are equal.
boolean	isSameNode(Node other) Returns whether this node is the same node as the given one.
boolean	isSupported(String feature, String version) Introduced in DOM Level 2.
Node	item(int index) NodeList method: Return the Nth immediate child of this node, or null if the index is out of bounds.
String	lookupNamespaceURI(String specifiedPrefix) DOM Level 3 - Experimental: Look up the namespace URI associated to the given prefix, starting from this node.
String	lookupPrefix(String namespaceURI) DOM Level 3 - Experimental: Look up the prefix associated to the given namespace URI, starting from this node.
final void	needsSyncChildren(boolean value)
void	normalize() Puts all `Text` nodes in the full depth of the sub-tree underneath this `Node`, including attribute nodes, into a "normal" form where only markup (e.g., tags, comments, processing instructions, CDATA sections, and entity references) separates `Text` nodes, i.e., there are no adjacent `Text` nodes.
Node	removeChild(Node oldChild) Remove a child from this Node.
void	removeEventListener(String type, EventListener listener, boolean useCapture)
Node	replaceChild(Node newChild, Node oldChild) Make newChild occupy the location that oldChild used to have.
void	setNodeValue(String x) Sets the node value.
void	setOwnerDocument(CoreDocumentImpl doc) NON-DOM set the ownerDocument of this node
void	setPrefix(String prefix) Introduced in DOM Level 2.
void	setReadOnly(boolean readOnly, boolean deep) NON-DOM: PR-DOM-Level-1-19980818 mentions readonly nodes in conjunction with Entities, but provides no API to support this.
void	setTextContent(String textContent) This attribute returns the text content of this node and its descendants.
Object	setUserData(String key, Object data, UserDataHandler handler) Associate an object to a key on this node.
void	setUserData(Object data) NON-DOM: As an alternative to subclassing the DOM, this implementation has been extended with the ability to attach an object to each node.
void	synchronizeData() Override this method in subclass to hook in efficient internal data structure.
String	toString() NON-DOM method for debugging convenience.

From class java.lang.Object

From interface org.w3c.dom.Node

abstract Node	appendChild(Node arg0)
abstract Node	cloneNode(boolean arg0)
abstract short	compareDocumentPosition(Node arg0)
abstract NamedNodeMap	getAttributes()
abstract String	getBaseURI()
abstract NodeList	getChildNodes()
abstract Object	getFeature(String arg0, String arg1)
abstract Node	getFirstChild()
abstract Node	getLastChild()
abstract String	getLocalName()
abstract String	getNamespaceURI()
abstract Node	getNextSibling()
abstract String	getNodeName()
abstract short	getNodeType()
abstract String	getNodeValue()
abstract Document	getOwnerDocument()
abstract Node	getParentNode()
abstract String	getPrefix()
abstract Node	getPreviousSibling()
abstract String	getTextContent()
abstract Object	getUserData(String arg0)
abstract boolean	hasAttributes()
abstract boolean	hasChildNodes()
abstract Node	insertBefore(Node arg0, Node arg1)
abstract boolean	isDefaultNamespace(String arg0)
abstract boolean	isEqualNode(Node arg0)
abstract boolean	isSameNode(Node arg0)
abstract boolean	isSupported(String arg0, String arg1)
abstract String	lookupNamespaceURI(String arg0)
abstract String	lookupPrefix(String arg0)
abstract void	normalize()
abstract Node	removeChild(Node arg0)
abstract Node	replaceChild(Node arg0, Node arg1)
abstract void	setNodeValue(String arg0)
abstract void	setPrefix(String arg0)
abstract void	setTextContent(String arg0)
abstract Object	setUserData(String arg0, Object arg1, UserDataHandler arg2)

From interface org.w3c.dom.NodeList

From interface org.w3c.dom.ProcessingInstruction

From interface org.w3c.dom.events.EventTarget

Fields

protected String target

Public Constructors

public ProcessingInstructionImpl (CoreDocumentImpl ownerDoc, String target, String data)

Factory constructor.

Public Methods

public String getBaseURI ()

Returns the absolute base URI of this node or null if the implementation wasn't able to obtain an absolute URI. Note: If the URI is malformed, a null is returned.

Returns

The absolute base URI of this node or null.

public 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

public String getNodeName ()

Returns the target

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.

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

public void setData (String data)

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

Throws

	if node is read-only.

Interfaces

Classes

Exceptions

ProcessingInstructionImpl

Class Overview

Summary

Fields

protected String target

Public Constructors

public ProcessingInstructionImpl (CoreDocumentImpl ownerDoc, String target, String data)

Public Methods

public String getBaseURI ()

Returns

public String getData ()

public String getNodeName ()

public short getNodeType ()

public String getTarget ()

public void setData (String data)

Throws

See Also