gnu.xml.dom

Class DomPI

public class DomPI extends DomNode implements ProcessingInstruction

"ProcessingInstruction" (PI) implementation. This is a non-core DOM class, supporting the "XML" feature.

Unlike other DOM APIs in the "XML" feature, this one fully exposes the functionality it describes. So there is no reason inherent in DOM to avoid using this API, unless you want to rely on NOTATION declarations to associate meaning with your PIs; there is no vendor-neutal way to record those notations in DOM.

Also of note is that PI support is part of SAX, so that XML systems using PIs can choose among multiple APIs.

Version: $Date: 2001/11/20 04:53:46 $

Author: David Brownell

See Also:

Constructor Summary
protected DomPI(Document owner, String target, String data)
Constructs a ProcessingInstruction node associated with the specified document, with the specified data.
Method Summary
StringgetData()
DOM L1 Returns the data associated with the processing instruction.
StringgetNodeName()
DOM L1 Returns the target of the processing instruction (same as getTarget).
shortgetNodeType()
DOM L1 Returns the constant PROCESSING_INSTRUCTION_NODE.
StringgetNodeValue()
DOM L1 Returns the data associated with the processing instruction (same as getData).
StringgetTarget()
DOM L1 Returns the target of the processing instruction.
voidsetData(String data)
DOM L1 Assigns the data associated with the processing instruction; same as setNodeValue.
voidsetNodeValue(String data)
DOM L1 Assigns the data associated with the processing instruction.

Constructor Detail

DomPI

protected DomPI(Document owner, String target, String data)
Constructs a ProcessingInstruction node associated with the specified document, with the specified data.

This constructor should only be invoked by a Document object as part of its createProcessingInstruction functionality, or through a subclass which is similarly used in a "Sub-DOM" style layer.

Method Detail

getData

public final String getData()
DOM L1 Returns the data associated with the processing instruction.

getNodeName

public final String getNodeName()
DOM L1 Returns the target of the processing instruction (same as getTarget).

getNodeType

public final short getNodeType()
DOM L1 Returns the constant PROCESSING_INSTRUCTION_NODE.

getNodeValue

public final String getNodeValue()
DOM L1 Returns the data associated with the processing instruction (same as getData).

getTarget

public final String getTarget()
DOM L1 Returns the target of the processing instruction.

setData

public final void setData(String data)
DOM L1 Assigns the data associated with the processing instruction; same as setNodeValue.

setNodeValue

public final void setNodeValue(String data)
DOM L1 Assigns the data associated with the processing instruction.

Source code is under GPL (with library exception) in the JAXP project at http://www.gnu.org/software/classpathx/jaxp
This documentation was derived from that source code on 2011-08-26.