nu.xom

Class ProcessingInstruction


public class ProcessingInstruction
extends Node

This class represents an XML processing instruction. Each processing instruction has two key properties:
Version:
1.0
Author:
Elliotte Rusty Harold

Constructor Summary

ProcessingInstruction(String target, String data)
Create a processing instruction with a certain target and data.
ProcessingInstruction(ProcessingInstruction instruction)
Create a copy of a processing instruction.

Method Summary

Node
copy()
Returns a deep copy of this processing instruction with no parent, that can be added to this document or a different one.
Node
getChild(int position)
Throws IndexOutOfBoundsException because processing instructions do not have children.
int
getChildCount()
Returns 0 because processing instructions do not have children.
String
getTarget()
Returns the processing instruction target.
String
getValue()
Returns the processing instruction data.
void
setTarget(String target)
Sets the target.
void
setValue(String data)
Sets the data.
String
toString()
Returns a String representation of this processing instruction suitable for debugging and diagnosis.
String
toXML()
Returns the actual XML form of this processing instruction, such as might be copied and pasted from the original document.

Methods inherited from class nu.xom.Node

copy, detach, equals, getBaseURI, getChild, getChildCount, getDocument, getParent, getValue, hashCode, query, query, toXML

Constructor Details

ProcessingInstruction

public ProcessingInstruction(String target,
                             String data)
Create a processing instruction with a certain target and data.
Parameters:
target - the target of the processing instruction
data - the processing instruction data

ProcessingInstruction

public ProcessingInstruction(ProcessingInstruction instruction)
Create a copy of a processing instruction.
Parameters:
instruction - the processing instruction to copy

Method Details

copy

public Node copy()
Returns a deep copy of this processing instruction with no parent, that can be added to this document or a different one.
Overrides:
copy in interface Node
Returns:
a copy of this ProcessingInstruction with no parent

getChild

public final Node getChild(int position)
Throws IndexOutOfBoundsException because processing instructions do not have children.
Overrides:
getChild in interface Node
Parameters:
position - the index of the child node to return
Returns:
never returns because processing instructions do not have children; always throws an exception.

getChildCount

public final int getChildCount()
Returns 0 because processing instructions do not have children.
Overrides:
getChildCount in interface Node
Returns:
zero

getTarget

public final String getTarget()
Returns the processing instruction target.
Returns:
the target

getValue

public final String getValue()
Returns the processing instruction data.
Overrides:
getValue in interface Node
Returns:
the data of the processing instruction

setTarget

public void setTarget(String target)
Sets the target.
Parameters:
target - the new target

setValue

public void setValue(String data)
Sets the data.
Parameters:
data - the data to set

toString

public final String toString()
Returns a String representation of this processing instruction suitable for debugging and diagnosis. This is not the XML representation of this processing instruction.
Returns:
a non-XML string representation of this ProcessingInstruction

toXML

public final String toXML()
Returns the actual XML form of this processing instruction, such as might be copied and pasted from the original document.
Overrides:
toXML in interface Node
Returns:
an XML representation of this processing instruction as a String

Copyright 2002-2005 Elliotte Rusty Harold
elharo@metalab.unc.edu