Package org.jdom

Class ProcessingInstruction

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable
    public class ProcessingInstruction
extends Content
    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.47 $, $Date: 2007/11/10 05:28:59 $
    Author:
    Brett McLaughlin, Jason Hunter, Steven Gould
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.util.Map mapData
      The data for the PI in name/value pairs
      protected java.lang.String rawData
      The data for the PI as a String
      protected java.lang.String target
      The target of the PI

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected ProcessingInstruction()
      Default, no-args constructor for implementations to use if needed.
        ProcessingInstruction​(java.lang.String target, java.lang.String data)
      This will create a new ProcessingInstruction with the specified target and data.
        ProcessingInstruction​(java.lang.String target, java.util.Map data)
      This will create a new ProcessingInstruction with the specified target and data.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Object clone()
      This will return a clone of this ProcessingInstruction.
      java.lang.String getData()
      This will return the raw data from all instructions.
      java.util.List getPseudoAttributeNames()
      This will return a List containing the names of the "attribute" style pieces of name/value pairs in this PI's data.
      java.lang.String getPseudoAttributeValue​(java.lang.String name)
      This will return the value for a specific name/value pair on the PI.
      java.lang.String getTarget()
      This will retrieve the target of the PI.
      java.lang.String getValue()
      Returns the XPath 1.0 string value of this element, which is the data of this PI.
      boolean removePseudoAttribute​(java.lang.String name)
      This will remove the pseudo attribute with the specified name.
      ProcessingInstruction setData​(java.lang.String data)
      This will set the raw data for the PI.
      ProcessingInstruction setData​(java.util.Map data)
      This will set the name/value pairs within the passed Map as the pairs for the data of this PI.
      ProcessingInstruction setPseudoAttribute​(java.lang.String name, java.lang.String value)
      This will set a pseudo attribute with the given name and value.
      ProcessingInstruction setTarget​(java.lang.String newTarget)
      This will set the target for the PI.
      java.lang.String toString()
      This returns a String representation of the ProcessingInstruction, suitable for debugging.

      • Methods inherited from class java.lang.Object

        finalize, getClass, notify, notifyAll, wait, wait, wait

    • Field Detail

      • target

        protected java.lang.String target
        The target of the PI

      • rawData

        protected java.lang.String rawData
        The data for the PI as a String

      • mapData

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

    • Constructor Detail

      • ProcessingInstruction

        protected ProcessingInstruction()
        Default, no-args constructor for implementations to use if needed.

      • ProcessingInstruction

        public ProcessingInstruction​(java.lang.String target,
                             java.util.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​(java.lang.String target,
                             java.lang.String data)
        This will create a new ProcessingInstruction with the specified target and data.
        Parameters:
        target - String target of PI.
        data - String data for PI.
        Throws:
        IllegalTargetException - if the given target is illegal as a processing instruction name.

    • Method Detail

      • setTarget

        public ProcessingInstruction setTarget​(java.lang.String newTarget)
        This will set the target for the PI.
        Parameters:
        newTarget - String new target of PI.
        Returns:
        ProcessingInstruction - this PI modified.

      • getValue

        public java.lang.String getValue()
        Returns the XPath 1.0 string value of this element, which is the data of this PI.
        Specified by:
        getValue in class Content
        Returns:
        the data of this PI

      • getTarget

        public java.lang.String getTarget()
        This will retrieve the target of the PI.
        Returns:
        String - target of PI.

      • getData

        public java.lang.String getData()
        This will return the raw data from all instructions.
        Returns:
        String - data of PI.

      • getPseudoAttributeNames

        public java.util.List getPseudoAttributeNames()
        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.

      • setData

        public ProcessingInstruction setData​(java.lang.String data)
        This will set the raw data for the PI.
        Parameters:
        data - String data of PI.
        Returns:
        ProcessingInstruction - this PI modified.

      • setData

        public ProcessingInstruction setData​(java.util.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.
        Parameters:
        data - new map data to use
        Returns:
        ProcessingInstruction - modified PI.

      • getPseudoAttributeValue

        public java.lang.String getPseudoAttributeValue​(java.lang.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.

      • setPseudoAttribute

        public ProcessingInstruction setPseudoAttribute​(java.lang.String name,
                                                java.lang.String value)
        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.

      • removePseudoAttribute

        public boolean removePseudoAttribute​(java.lang.String name)
        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.

      • toString

        public java.lang.String toString()
        This returns a String representation of the ProcessingInstruction, suitable for debugging. If the XML representation of the ProcessingInstruction is desired, XMLOutputter.outputString(ProcessingInstruction) should be used.
        Overrides:
        toString in class java.lang.Object
        Returns:
        String - information about the ProcessingInstruction

      • clone

        public java.lang.Object clone()
        This will return a clone of this ProcessingInstruction.
        Overrides:
        clone in class Content
        Returns:
        Object - clone of this ProcessingInstruction.