Main Page | Class Hierarchy | Class List | Class Members

org::jdom::ProcessingInstruction Class Reference

Inheritance diagram for org::jdom::ProcessingInstruction:

org::jdom::Content List of all members.

Public Member Functions

 ProcessingInstruction (String target, Map data)
 ProcessingInstruction (String target, String data)
ProcessingInstruction setTarget (String newTarget)
String getValue ()
String getTarget ()
String getData ()
List getPseudoAttributeNames ()
ProcessingInstruction setData (String data)
ProcessingInstruction setData (Map data)
String getPseudoAttributeValue (String name)
ProcessingInstruction setPseudoAttribute (String name, String value)
boolean removePseudoAttribute (String name)
String toString ()
Object clone ()

Protected Member Functions

 ProcessingInstruction ()

Protected Attributes

String target
String rawData
Map mapData

Detailed Description

An XML processing instruction. 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 or, if the data appears akin to an attribute list, can be retrieved as name/value pairs.

Version:
Revision
1.46
,
Date
2004/02/27 11:32:57
Author:
Brett McLaughlin

Jason Hunter

Steven Gould


Constructor & Destructor Documentation

org::jdom::ProcessingInstruction::ProcessingInstruction  )  [inline, protected]
 

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

org::jdom::ProcessingInstruction::ProcessingInstruction String  target,
Map  data
[inline]
 

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
Exceptions:
IllegalTargetException if the given target is illegal as a processing instruction name.

org::jdom::ProcessingInstruction::ProcessingInstruction String  target,
String  data
[inline]
 

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

Parameters:
target String target of PI.
data String data for PI.
Exceptions:
IllegalTargetException if the given target is illegal as a processing instruction name.


Member Function Documentation

Object org::jdom::ProcessingInstruction::clone  )  [inline]
 

This will return a clone of this ProcessingInstruction.

Returns:
Object - clone of this ProcessingInstruction.

Reimplemented from org::jdom::Content.

String org::jdom::ProcessingInstruction::getData  )  [inline]
 

This will return the raw data from all instructions.

Returns:
String - data of PI.

List org::jdom::ProcessingInstruction::getPseudoAttributeNames  )  [inline]
 

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.

String org::jdom::ProcessingInstruction::getPseudoAttributeValue String  name  )  [inline]
 

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.

String org::jdom::ProcessingInstruction::getTarget  )  [inline]
 

This will retrieve the target of the PI.

Returns:
String - target of PI.

String org::jdom::ProcessingInstruction::getValue  )  [inline, virtual]
 

Returns the XPath 1.0 string value of this element, which is the data of this PI.

Returns:
the data of this PI

Implements org::jdom::Content.

boolean org::jdom::ProcessingInstruction::removePseudoAttribute String  name  )  [inline]
 

This will remove the pseudo attribute with the specified name.

Parameters:
name name of pseudo attribute to remove
Returns:
boolean - whether the requested instruction was removed.

ProcessingInstruction org::jdom::ProcessingInstruction::setData Map  data  )  [inline]
 

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.

Parameters:
data new map data to use
Returns:
ProcessingInstruction - modified PI.

ProcessingInstruction org::jdom::ProcessingInstruction::setData String  data  )  [inline]
 

This will set the raw data for the PI.

Parameters:
data String data of PI.
Returns:
ProcessingInstruction - this PI modified.

ProcessingInstruction org::jdom::ProcessingInstruction::setPseudoAttribute String  name,
String  value
[inline]
 

This will set a pseudo attribute with the given name and value. If the PI data is not already in a pseudo-attribute format, this will replace the existing data.

Parameters:
name String name of pair.
value String value for pair.
Returns:
ProcessingInstruction this PI modified.

ProcessingInstruction org::jdom::ProcessingInstruction::setTarget String  newTarget  )  [inline]
 

This will set the target for the PI.

Parameters:
newTarget String new target of PI.
Returns:
ProcessingInstruction - this PI modified.

String org::jdom::ProcessingInstruction::toString  )  [inline]
 

This returns a String representation of the ProcessingInstruction, suitable for debugging. If the XML representation of the ProcessingInstruction is desired, org.jdom.output.XMLOutputter#outputString(ProcessingInstruction) should be used.

Returns:
String - information about the ProcessingInstruction


Member Data Documentation

Map org::jdom::ProcessingInstruction::mapData [protected]
 

The data for the PI in name/value pairs

String org::jdom::ProcessingInstruction::rawData [protected]
 

The data for the PI as a String

String org::jdom::ProcessingInstruction::target [protected]
 

The target of the PI


The documentation for this class was generated from the following file:
Generated on Thu Dec 9 10:42:05 2004 for JDOM by  doxygen 1.3.9.1