org.jdom
Class ProcessingInstruction

public class ProcessingInstruction

implements Cloneable, Serializable

ProcessingInstruction defines behavior for an XML processing instruction, modeled in Java. Methods allow the user to obtain the target of the PI as well as its data. The data can always be accessed as a String, and where appropriate can be retrieved as name/value pairs.

Author:

Brett McLaughlin, Jason Hunter

Version: 1.0

public ProcessingInstruction(String target, Map data)

This will create a new ProcessingInstruction with the specified target and data.

Parameters:

target - String target of PI.

data - Map data for PI, in name/value pairs

public ProcessingInstruction(String target, String data)

This will create a new ProcessingInstruction with the specified target and data.

Parameters:

target - String target of PI.

rawData - String data for PI.

public Object clone()

This will return a clone of this ProcessingInstruction.

Returns: Object - clone of this ProcessingInstruction.

public final boolean equals(Object ob)

This tests for equality of this ProcessingInstruction to the supplied Object.

Parameters:

ob - Object to compare to.

Returns: boolean - whether the ProcessingInstruction is equal to the supplied Object.

public String getData()

This will return the raw data from all instructions.

Returns: String - data of PI.

public Document getDocument()

This retrieves the owning Document for this PI, or null if not a currently a member of a Document.

Returns: Document owning this PI, or null.

public Element getParent()

This will return the parent of this ProcessingInstruction. If there is no parent, then this returns null.

Returns: parent of this ProcessingInstruction

public final String getSerializedForm()

This will return the Comment in XML format, usable in an XML document.

Returns: String - the serialized form of the Comment.

public String getTarget()

This will retrieve the target of the PI.

Returns: String - target of PI.

public String getValue(String name)

This will return the value for a specific name/value pair on the PI. If no such pair is found for this PI, an empty String will result.

Parameters:

name - String name of name/value pair to lookup value for.

Returns: String - value of name/value pair.

public final int hashCode()

This returns the hash code for this ProcessingInstruction.

Returns: int - hash code.

public boolean removeValue(String name)

This will remove the name/value pair with the specified name.

Returns: boolean - whether the requested instruction was removed.

public ProcessingInstruction setData(String data)

This will set the raw data for the PI.

Parameters:

rawData - String data of PI.

Returns: ProcessingInstruction - this PI modified.

public ProcessingInstruction setData(Map data)

This will set the name/value pairs within the passed Map as the pairs for the data of this PI. The keys should be the pair name and the values should be the pair values.

Returns: ProcessingInstruction - modified PI.

public ProcessingInstruction setValue(String name, String value)

This will set the value for the specified name/value pair. If no matching pair is found, the supplied pair is added to the PI data.

Parameters:

name - String name of pair.

value - String value for pair.

Returns: ProcessingInstruction this PI modified.

public String toString()

This returns a String representation of the ProcessingInstruction, suitable for debugging. If the XML representation of the ProcessingInstruction is desired, getSerializedForm() should be used.

Returns: String - information about the ProcessingInstruction

Association Links

to Class java.lang.String

The target of the PI

to Class java.lang.String

The data for the PI as a String

to Class java.util.Map

The data for the PI in name/value pairs

to Class org.jdom.Element

Parent element, or null if none

to Class org.jdom.Document

Document node if PI is outside the root element, or null if none