123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473 |
- /*--
-
- $Id: ProcessingInstruction.java,v 1.47 2007/11/10 05:28:59 jhunter Exp $
-
- Copyright (C) 2000-2007 Jason Hunter & Brett McLaughlin.
- All rights reserved.
-
- Redistribution and use in source and binary forms, with or without
- modification, are permitted provided that the following conditions
- are met:
-
- 1. Redistributions of source code must retain the above copyright
- notice, this list of conditions, and the following disclaimer.
-
- 2. Redistributions in binary form must reproduce the above copyright
- notice, this list of conditions, and the disclaimer that follows
- these conditions in the documentation and/or other materials
- provided with the distribution.
-
- 3. The name "JDOM" must not be used to endorse or promote products
- derived from this software without prior written permission. For
- written permission, please contact <request_AT_jdom_DOT_org>.
-
- 4. Products derived from this software may not be called "JDOM", nor
- may "JDOM" appear in their name, without prior written permission
- from the JDOM Project Management <request_AT_jdom_DOT_org>.
-
- In addition, we request (but do not require) that you include in the
- end-user documentation provided with the redistribution and/or in the
- software itself an acknowledgement equivalent to the following:
- "This product includes software developed by the
- JDOM Project (http://www.jdom.org/)."
- Alternatively, the acknowledgment may be graphical using the logos
- available at http://www.jdom.org/images/logos.
-
- THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
- WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
- OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- DISCLAIMED. IN NO EVENT SHALL THE JDOM AUTHORS OR THE PROJECT
- CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
- USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
- ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
- OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
- SUCH DAMAGE.
-
- This software consists of voluntary contributions made by many
- individuals on behalf of the JDOM Project and was originally
- created by Jason Hunter <jhunter_AT_jdom_DOT_org> and
- Brett McLaughlin <brett_AT_jdom_DOT_org>. For more information
- on the JDOM Project, please see <http://www.jdom.org/>.
-
- */
-
- package org.jdom;
-
- import java.util.*;
-
- /**
- * 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
- * @author Jason Hunter
- * @author Steven Gould
- */
-
- public class ProcessingInstruction extends Content {
-
- private static final String CVS_ID =
- "@(#) $RCSfile: ProcessingInstruction.java,v $ $Revision: 1.47 $ $Date: 2007/11/10 05:28:59 $ $Name: jdom_1_1 $";
-
- /** The target of the PI */
- protected String target;
-
- /** The data for the PI as a String */
- protected String rawData;
-
- /** The data for the PI in name/value pairs */
- protected Map mapData;
-
- /**
- * Default, no-args constructor for implementations
- * to use if needed.
- */
- protected ProcessingInstruction() { }
-
- /**
- * This will create a new <code>ProcessingInstruction</code>
- * with the specified target and data.
- *
- * @param target <code>String</code> target of PI.
- * @param data <code>Map</code> data for PI, in
- * name/value pairs
- * @throws IllegalTargetException if the given target is illegal
- * as a processing instruction name.
- */
- public ProcessingInstruction(String target, Map data) {
- setTarget(target);
- setData(data);
- }
-
- /**
- * This will create a new <code>ProcessingInstruction</code>
- * with the specified target and data.
- *
- * @param target <code>String</code> target of PI.
- * @param data <code>String</code> data for PI.
- * @throws IllegalTargetException if the given target is illegal
- * as a processing instruction name.
- */
- public ProcessingInstruction(String target, String data) {
- setTarget(target);
- setData(data);
- }
-
- /**
- * This will set the target for the PI.
- *
- * @param newTarget <code>String</code> new target of PI.
- * @return <code>ProcessingInstruction</code> - this PI modified.
- */
- public ProcessingInstruction setTarget(String newTarget) {
- String reason;
- if ((reason = Verifier.checkProcessingInstructionTarget(newTarget))
- != null) {
- throw new IllegalTargetException(newTarget, reason);
- }
-
- target = newTarget;
- return this;
- }
-
- /**
- * Returns the XPath 1.0 string value of this element, which is the
- * data of this PI.
- *
- * @return the data of this PI
- */
- public String getValue() {
- return rawData;
- }
-
-
- /**
- * This will retrieve the target of the PI.
- *
- * @return <code>String</code> - target of PI.
- */
- public String getTarget() {
- return target;
- }
-
- /**
- * This will return the raw data from all instructions.
- *
- * @return <code>String</code> - data of PI.
- */
- public String getData() {
- return rawData;
- }
-
- /**
- * This will return a <code>List</code> containing the names of the
- * "attribute" style pieces of name/value pairs in this PI's data.
- *
- * @return <code>List</code> - the <code>List</code> containing the
- * "attribute" names.
- */
- public List getPseudoAttributeNames() {
- Set mapDataSet = mapData.entrySet();
- List nameList = new ArrayList();
- for (Iterator i = mapDataSet.iterator(); i.hasNext();) {
- String wholeSet = (i.next()).toString();
- String attrName = wholeSet.substring(0,(wholeSet.indexOf("=")));
- nameList.add(attrName);
- }
- return nameList;
- }
-
- /**
- * This will set the raw data for the PI.
- *
- * @param data <code>String</code> data of PI.
- * @return <code>ProcessingInstruction</code> - this PI modified.
- */
- public ProcessingInstruction setData(String data) {
- String reason = Verifier.checkProcessingInstructionData(data);
- if (reason != null) {
- throw new IllegalDataException(data, reason);
- }
-
- this.rawData = data;
- this.mapData = parseData(data);
- return this;
- }
-
- /**
- * This will set the name/value pairs within the passed
- * <code>Map</code> as the pairs for the data of
- * this PI. The keys should be the pair name
- * and the values should be the pair values.
- *
- * @param data new map data to use
- * @return <code>ProcessingInstruction</code> - modified PI.
- */
- public ProcessingInstruction setData(Map data) {
- String temp = toString(data);
-
- String reason = Verifier.checkProcessingInstructionData(temp);
- if (reason != null) {
- throw new IllegalDataException(temp, reason);
- }
-
- this.rawData = temp;
- this.mapData = data;
- return this;
- }
-
-
- /**
- * 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.
- *
- * @param name <code>String</code> name of name/value pair
- * to lookup value for.
- * @return <code>String</code> - value of name/value pair.
- */
- public String getPseudoAttributeValue(String name) {
- return (String)mapData.get(name);
- }
-
- /**
- * 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.
- *
- * @param name <code>String</code> name of pair.
- * @param value <code>String</code> value for pair.
- * @return <code>ProcessingInstruction</code> this PI modified.
- */
- public ProcessingInstruction setPseudoAttribute(String name, String value) {
- String reason = Verifier.checkProcessingInstructionData(name);
- if (reason != null) {
- throw new IllegalDataException(name, reason);
- }
-
- reason = Verifier.checkProcessingInstructionData(value);
- if (reason != null) {
- throw new IllegalDataException(value, reason);
- }
-
- this.mapData.put(name, value);
- this.rawData = toString(mapData);
- return this;
- }
-
-
- /**
- * This will remove the pseudo attribute with the specified name.
- *
- * @param name name of pseudo attribute to remove
- * @return <code>boolean</code> - whether the requested
- * instruction was removed.
- */
- public boolean removePseudoAttribute(String name) {
- if ((mapData.remove(name)) != null) {
- rawData = toString(mapData);
- return true;
- }
-
- return false;
- }
-
- /**
- * This will convert the Map to a string representation.
- *
- * @param mapData <code>Map</code> PI data to convert
- * @return a string representation of the Map as appropriate for a PI
- */
- private String toString(Map mapData) {
- StringBuffer rawData = new StringBuffer();
-
- Iterator i = mapData.keySet().iterator();
- while (i.hasNext()) {
- String name = (String)i.next();
- String value = (String)mapData.get(name);
- rawData.append(name)
- .append("=\"")
- .append(value)
- .append("\" ");
- }
- // Remove last space, if we did any appending
- if (rawData.length() > 0) {
- rawData.setLength(rawData.length() - 1);
- }
-
- return rawData.toString();
- }
-
- /**
- * This will parse and load the instructions for the PI.
- * This is separated to allow it to occur once and then be reused.
- */
- private Map parseData(String rawData) {
- // The parsing here is done largely "by hand" which means the code
- // gets a little tricky/messy. The following conditions should
- // now be handled correctly:
- // <?pi href="http://hi/a=b"?> Reads OK
- // <?pi href = 'http://hi/a=b' ?> Reads OK
- // <?pi href\t = \t'http://hi/a=b'?> Reads OK
- // <?pi href = "http://hi/a=b"?> Reads OK
- // <?pi?> Empty Map
- // <?pi id=22?> Empty Map
- // <?pi id='22?> Empty Map
-
- Map data = new HashMap();
-
- // System.out.println("rawData: " + rawData);
-
- // The inputData variable holds the part of rawData left to parse
- String inputData = rawData.trim();
-
- // Iterate through the remaining inputData string
- while (!inputData.trim().equals("")) {
- //System.out.println("parseData() looking at: " + inputData);
-
- // Search for "name =", "name=" or "name1 name2..."
- String name = "";
- String value = "";
- int startName = 0;
- char previousChar = inputData.charAt(startName);
- int pos = 1;
- for (; pos<inputData.length(); pos++) {
- char currentChar = inputData.charAt(pos);
- if (currentChar == '=') {
- name = inputData.substring(startName, pos).trim();
- // Get the boundaries on the quoted string
- // We use boundaries so we know where to start next
- int[] bounds = extractQuotedString(
- inputData.substring(pos+1));
- // A null value means a parse error and we return empty!
- if (bounds == null) {
- return new HashMap();
- }
- value = inputData.substring(bounds[0]+pos+1,
- bounds[1]+pos+1);
- pos += bounds[1] + 1; // skip past value
- break;
- }
- else if (Character.isWhitespace(previousChar)
- && !Character.isWhitespace(currentChar)) {
- startName = pos;
- }
-
- previousChar = currentChar;
- }
-
- // Remove the first pos characters; they have been processed
- inputData = inputData.substring(pos);
-
- // System.out.println("Extracted (name, value) pair: ("
- // + name + ", '" + value+"')");
-
- // If both a name and a value have been found, then add
- // them to the data Map
- if (name.length() > 0 && value != null) {
- //if (data.containsKey(name)) {
- // A repeat, that's a parse error, so return a null map
- //return new HashMap();
- //}
- //else {
- data.put(name, value);
- //}
- }
- }
-
- return data;
- }
-
- /**
- * This is a helper routine, only used by parseData, to extract a
- * quoted String from the input parameter, rawData. A quoted string
- * can use either single or double quotes, but they must match up.
- * A singly quoted string can contain an unbalanced amount of double
- * quotes, or vice versa. For example, the String "JDOM's the best"
- * is legal as is 'JDOM"s the best'.
- *
- * @param rawData the input string from which a quoted string is to
- * be extracted.
- * @return the first quoted string encountered in the input data. If
- * no quoted string is found, then the empty string, "", is
- * returned.
- * @see #parseData
- */
- private static int[] extractQuotedString(String rawData) {
- // Remembers whether we're actually in a quoted string yet
- boolean inQuotes = false;
-
- // Remembers which type of quoted string we're in
- char quoteChar = '"';
-
- // Stores the position of the first character inside
- // the quoted string (i.e. the start of the return string)
- int start = 0;
-
- // Iterate through the input string looking for the start
- // and end of the quoted string
- for (int pos=0; pos < rawData.length(); pos++) {
- char currentChar = rawData.charAt(pos);
- if (currentChar=='"' || currentChar=='\'') {
- if (!inQuotes) {
- // We're entering a quoted string
- quoteChar = currentChar;
- inQuotes = true;
- start = pos+1;
- }
- else if (quoteChar == currentChar) {
- // We're leaving a quoted string
- inQuotes = false;
- return new int[] { start, pos };
- }
- // Otherwise we've encountered a quote
- // inside a quote, so just continue
- }
- }
-
- return null;
- }
-
- /**
- * This returns a <code>String</code> representation of the
- * <code>ProcessingInstruction</code>, suitable for debugging. If the XML
- * representation of the <code>ProcessingInstruction</code> is desired,
- * {@link org.jdom.output.XMLOutputter#outputString(ProcessingInstruction)}
- * should be used.
- *
- * @return <code>String</code> - information about the
- * <code>ProcessingInstruction</code>
- */
- public String toString() {
- return new StringBuffer()
- .append("[ProcessingInstruction: ")
- .append(new org.jdom.output.XMLOutputter().outputString(this))
- .append("]")
- .toString();
- }
-
- /**
- * This will return a clone of this <code>ProcessingInstruction</code>.
- *
- * @return <code>Object</code> - clone of this
- * <code>ProcessingInstruction</code>.
- */
- public Object clone() {
- ProcessingInstruction pi = (ProcessingInstruction) super.clone();
-
- // target and rawdata are immutable and references copied by
- // Object.clone()
-
- // Create a new Map object for the clone (since Map isn't Cloneable)
- if (mapData != null) {
- pi.mapData = parseData(rawData);
- }
- return pi;
- }
- }
|