org.jdom
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 $
Field Summary | |
---|---|
protected Map | mapData The data for the PI in name/value pairs |
protected Object | parent Parent element, document, or null if none |
protected String | rawData The data for the PI as a String |
protected String | target 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(String target, String data)
This will create a new |
Method Summary | |
---|---|
Object | clone()
This will return a clone of this |
ProcessingInstruction | detach() This detaches the PI from its parent, or does nothing if the PI has no parent. |
boolean | equals(Object ob)
This tests for equality of this |
String | getData() This will return the raw data from all instructions. |
Document | getDocument() |
List | getNames()
This will return a |
Element | getParent()
This will return the parent of this |
String | getTarget() This will retrieve the target of the PI. |
String | getValue(String name) This will return the value for a specific name/value pair on the PI. |
int | hashCode()
This returns the hash code for this |
boolean | removeValue(String name) This will remove the name/value pair with the specified name. |
ProcessingInstruction | setData(String data) This will set the raw data for the PI. |
ProcessingInstruction | setData(Map data)
This will set the name/value pairs within the passed
|
protected ProcessingInstruction | setDocument(Document document)
This sets the |
protected ProcessingInstruction | setParent(Element parent)
This will set the parent of this |
ProcessingInstruction | setValue(String name, String value) This will set the value for the specified name/value pair. |
String | toString()
This returns a |
Default, no-args constructor for implementations to use if needed.
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.
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.
This will return a clone of this ProcessingInstruction
.
Returns: Object
- clone of this
ProcessingInstruction
.
This detaches the PI from its parent, or does nothing if the PI has no parent.
Returns: ProcessingInstruction
- this
ProcessingInstruction
modified.
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
.
This will return the raw data from all instructions.
Returns: String
- data of PI.
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.
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.
This will return the parent of this ProcessingInstruction
.
If there is no parent, then this returns null
.
Returns: parent of this ProcessingInstruction
This will retrieve the target of the PI.
Returns: String
- target of PI.
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.
This returns the hash code for this ProcessingInstruction
.
Returns: int
- hash code.
This will remove the name/value pair with the specified name.
Returns: boolean
- whether the requested
instruction was removed.
This will set the raw data for the PI.
Parameters: rawData String
data of PI.
Returns: ProcessingInstruction
- this PI modified.
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.
This sets the Document
parent of this PI.
Parameters: document Document
parent
Returns: this PI
modified
This will set the parent of this ProcessingInstruction
.
Parameters: parent Element
to be new parent.
Returns: this ProcessingInstruction
modified.
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.
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