org.jdom

Class ProcessingInstruction

public class ProcessingInstruction extends Object implements Serializable, Cloneable

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.

Version: $Revision: 1.27 $, $Date: 2002/03/20 15:16:32 $

Author: Brett McLaughlin Jason Hunter Steven Gould

Field Summary
protected MapmapData
The data for the PI in name/value pairs
protected Objectparent
Parent element, document, or null if none
protected StringrawData
The data for the PI as a String
protected Stringtarget
The target of the PI
Constructor Summary
protected ProcessingInstruction()

Default, no-args constructor for implementations to use if needed.

ProcessingInstruction(String target, Map data)

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

ProcessingInstruction(String target, String data)

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

Method Summary
Objectclone()

This will return a clone of this ProcessingInstruction.

ProcessingInstructiondetach()

This detaches the PI from its parent, or does nothing if the PI has no parent.

booleanequals(Object ob)

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

StringgetData()

This will return the raw data from all instructions.

DocumentgetDocument()

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

ListgetNames()

This will return a List containing the names of the "attribute" style pieces of name/value pairs in this PI's data.

ElementgetParent()

This will return the parent of this ProcessingInstruction.

StringgetTarget()

This will retrieve the target of the PI.

StringgetValue(String name)

This will return the value for a specific name/value pair on the PI.

inthashCode()

This returns the hash code for this ProcessingInstruction.

booleanremoveValue(String name)

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

ProcessingInstructionsetData(String data)

This will set the raw data for the PI.

ProcessingInstructionsetData(Map data)

This will set the name/value pairs within the passed Map as the pairs for the data of this PI.

protected ProcessingInstructionsetDocument(Document document)

This sets the Document parent of this PI.

protected ProcessingInstructionsetParent(Element parent)

This will set the parent of this ProcessingInstruction.

ProcessingInstructionsetValue(String name, String value)

This will set the value for the specified name/value pair.

StringtoString()

This returns a String representation of the ProcessingInstruction, suitable for debugging.

Field Detail

mapData

protected Map mapData
The data for the PI in name/value pairs

parent

protected Object parent
Parent element, document, or null if none

rawData

protected String rawData
The data for the PI as a String

target

protected String target
The target of the PI

Constructor Detail

ProcessingInstruction

protected ProcessingInstruction()

Default, no-args constructor for implementations to use if needed.

ProcessingInstruction

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

Throws: IllegalTargetException if the given target is illegal as a processing instruction name.

ProcessingInstruction

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.

Throws: IllegalTargetException if the given target is illegal as a processing instruction name.

Method Detail

clone

public Object clone()

This will return a clone of this ProcessingInstruction.

Returns: Object - clone of this ProcessingInstruction.

detach

public ProcessingInstruction detach()

This detaches the PI from its parent, or does nothing if the PI has no parent.

Returns: ProcessingInstruction - this ProcessingInstruction modified.

equals

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.

getData

public String getData()

This will return the raw data from all instructions.

Returns: String - data of PI.

getDocument

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.

getNames

public List getNames()

This will return a List containing the names of the "attribute" style pieces of name/value pairs in this PI's data.

Returns: List - the List containing the "attribute" names.

getParent

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

getTarget

public String getTarget()

This will retrieve the target of the PI.

Returns: String - target of PI.

getValue

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, null is returned.

Parameters: name String name of name/value pair to lookup value for.

Returns: String - value of name/value pair.

hashCode

public final int hashCode()

This returns the hash code for this ProcessingInstruction.

Returns: int - hash code.

removeValue

public boolean removeValue(String name)

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

Returns: boolean - whether the requested instruction was removed.

setData

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.

setData

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.

setDocument

protected ProcessingInstruction setDocument(Document document)

This sets the Document parent of this PI.

Parameters: document Document parent

Returns: this PI modified

setParent

protected ProcessingInstruction setParent(Element parent)

This will set the parent of this ProcessingInstruction.

Parameters: parent Element to be new parent.

Returns: this ProcessingInstruction modified.

setValue

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.

toString

public String toString()

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

Returns: String - information about the ProcessingInstruction

Copyright B) 2002 Jason Hunter, Brett McLaughlin. All Rights Reserved.