Mercurial > repos > pfrommolt > ngsrich
diff NGSrich_0.5.5/src/org/jdom/CDATA.java @ 0:89ad0a9cca52 default tip
Uploaded
author | pfrommolt |
---|---|
date | Mon, 21 Nov 2011 08:12:19 -0500 |
parents | |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/NGSrich_0.5.5/src/org/jdom/CDATA.java Mon Nov 21 08:12:19 2011 -0500 @@ -0,0 +1,205 @@ +/*-- + + $Id: CDATA.java,v 1.32 2007/11/10 05:28:58 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; + +/** + * An XML CDATA section. Represents character-based content within an XML + * document that should be output within special CDATA tags. Semantically it's + * identical to a simple {@link Text} object, but output behavior is different. + * CDATA makes no guarantees about the underlying textual representation of + * character data, but does expose that data as a Java String. + * + * @version $Revision: 1.32 $, $Date: 2007/11/10 05:28:58 $ + * @author Dan Schaffer + * @author Brett McLaughlin + * @author Jason Hunter + * @author Bradley S. Huffman + * @author Victor Toni + */ +public class CDATA extends Text { + + private static final String CVS_ID = + "@(#) $RCSfile: CDATA.java,v $ $Revision: 1.32 $ $Date: 2007/11/10 05:28:58 $ $Name: jdom_1_1_1 $"; + + /** + * This is the protected, no-args constructor standard in all JDOM + * classes. It allows subclassers to get a raw instance with no + * initialization. + */ + protected CDATA() { } + + /** + * This constructor creates a new <code>CDATA</code> node, with the + * supplied string value as it's character content. + * + * @param string the node's character content. + * @throws IllegalDataException if <code>str</code> contains an + * illegal character such as a vertical tab (as determined + * by {@link org.jdom.Verifier#checkCharacterData}) + * or the CDATA end delimiter <code>]]></code>. + */ + public CDATA(final String string) { + setText(string); + } + + /** + * This will set the value of this <code>CDATA</code> node. + * + * @param str value for node's content. + * @return the object on which the method was invoked + * @throws IllegalDataException if <code>str</code> contains an + * illegal character such as a vertical tab (as determined + * by {@link org.jdom.Verifier#checkCharacterData}) + * or the CDATA end delimiter <code>]]></code>. + */ + public Text setText(final String str) { + // Overrides Text.setText() because this needs to check that CDATA rules + // are enforced. We could have a separate Verifier check for CDATA + // beyond Text and call that alone before super.setText(). + + if (str == null || "".equals(str)) { + value = EMPTY_STRING; + return this; + } + + final String reason = Verifier.checkCDATASection(str); + if (reason != null) { + throw new IllegalDataException(str, "CDATA section", reason); + } + + value = str; + + return this; + } + + /** + * This will append character content to whatever content already + * exists within this <code>CDATA</code> node. + * + * @param str character content to append. + * @throws IllegalDataException if <code>str</code> contains an + * illegal character such as a vertical tab (as determined + * by {@link org.jdom.Verifier#checkCharacterData}) + * or the CDATA end delimiter <code>]]></code>. + */ + public void append(final String str) { + // Overrides Text.append(String) because this needs to check that CDATA + // rules are enforced. We could have a separate Verifier check for CDATA + // beyond Text and call that alone before super.setText(). + + if (str == null || "".equals(str)) { + return; + } + + // we need a temp value to ensure that the value is changed _after_ + // validation + final String tmpValue; + if (value == EMPTY_STRING) { + tmpValue = str; + } else { + tmpValue = value + str; + } + + // we have to do late checking since the end of a CDATA section could + // have been created by concating both strings: + // "]" + "]>" + // or + // "]]" + ">" + // TODO: maybe this could be optimized for this two cases + final String reason = Verifier.checkCDATASection(tmpValue); + if (reason != null) { + throw new IllegalDataException(str, "CDATA section", reason); + } + + value = tmpValue; + } + + /** + * This will append the content of another <code>Text</code> node + * to this node. + * + * @param text Text node to append. + */ + public void append(final Text text) { + // Overrides Text.append(Text) because this needs to check that CDATA + // rules are enforced. We could have a separate Verifier check for CDATA + // beyond Text and call that alone before super.setText(). + + if (text == null) { + return; + } + append(text.getText()); + } + + /** + * This returns a <code>String</code> representation of the + * <code>CDATA</code> node, suitable for debugging. If the XML + * representation of the <code>CDATA</code> node is desired, + * either <code>{@link #getText}</code> or + * {@link org.jdom.output.XMLOutputter#output(CDATA, java.io.Writer)}</code> + * should be used. + * + * @return <code>String</code> - information about this node. + */ + public String toString() { + return new StringBuffer(64) + .append("[CDATA: ") + .append(getText()) + .append("]") + .toString(); + } +}