FileDocCategorySizeDatePackage
ProcessingInstructionImpl.javaAPI DocApache Xerces 3.0.14697Fri Sep 14 20:33:54 BST 2007org.apache.xerces.dom

ProcessingInstructionImpl

public class ProcessingInstructionImpl extends CharacterDataImpl 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. This class inherits from CharacterDataImpl to reuse its setNodeValue method.
xerces.internal
version
$Id: ProcessingInstructionImpl.java 447266 2006-09-18 05:57:49Z mrglavas $
since
PR-DOM-Level-1-19980818.

Fields Summary
static final long
serialVersionUID
Serialization version.
protected String
target
Constructors Summary
public ProcessingInstructionImpl(CoreDocumentImpl ownerDoc, String target, String data)
Factory constructor.


    //
    // Constructors
    //

       
      
                                         
        super(ownerDoc, data);
        this.target = target;
Methods Summary
public java.lang.StringgetBaseURI()
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.

return
The absolute base URI of this node or null.
since
DOM Level 3


        if (needsSyncData()) {
            synchronizeData();
        }
        return ownerNode.getBaseURI();
public java.lang.StringgetData()
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

        if (needsSyncData()) {
            synchronizeData();
        }
        return data;
public java.lang.StringgetNodeName()
Returns the target

        if (needsSyncData()) {
            synchronizeData();
        }
        return target;
public shortgetNodeType()
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.

        return Node.PROCESSING_INSTRUCTION_NODE;
public java.lang.StringgetTarget()
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.

        if (needsSyncData()) {
            synchronizeData();
        }
        return target;
public voidsetData(java.lang.String data)
Change the data content of this PI. Note that setData is aliased to setNodeValue.

see
#getData().
throws
DOMException(NO_MODIFICATION_ALLOWED_ERR) if node is read-only.

        // Hand off to setNodeValue for code-reuse reasons (mutation
        // events, readonly protection, synchronizing, etc.)
        setNodeValue(data);