001: /*--
002:
003: $Id: Comment.java,v 1.1 2005/04/27 09:32:38 wittek Exp $
004:
005: Copyright (C) 2000-2004 Jason Hunter & Brett McLaughlin.
006: All rights reserved.
007:
008: Redistribution and use in source and binary forms, with or without
009: modification, are permitted provided that the following conditions
010: are met:
011:
012: 1. Redistributions of source code must retain the above copyright
013: notice, this list of conditions, and the following disclaimer.
014:
015: 2. Redistributions in binary form must reproduce the above copyright
016: notice, this list of conditions, and the disclaimer that follows
017: these conditions in the documentation and/or other materials
018: provided with the distribution.
019:
020: 3. The name "JDOM" must not be used to endorse or promote products
021: derived from this software without prior written permission. For
022: written permission, please contact <request_AT_jdom_DOT_org>.
023:
024: 4. Products derived from this software may not be called "JDOM", nor
025: may "JDOM" appear in their name, without prior written permission
026: from the JDOM Project Management <request_AT_jdom_DOT_org>.
027:
028: In addition, we request (but do not require) that you include in the
029: end-user documentation provided with the redistribution and/or in the
030: software itself an acknowledgement equivalent to the following:
031: "This product includes software developed by the
032: JDOM Project (http://www.jdom.org/)."
033: Alternatively, the acknowledgment may be graphical using the logos
034: available at http://www.jdom.org/images/logos.
035:
036: THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
037: WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
038: OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
039: DISCLAIMED. IN NO EVENT SHALL THE JDOM AUTHORS OR THE PROJECT
040: CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
041: SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
042: LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
043: USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
044: ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
045: OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
046: OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
047: SUCH DAMAGE.
048:
049: This software consists of voluntary contributions made by many
050: individuals on behalf of the JDOM Project and was originally
051: created by Jason Hunter <jhunter_AT_jdom_DOT_org> and
052: Brett McLaughlin <brett_AT_jdom_DOT_org>. For more information
053: on the JDOM Project, please see <http://www.jdom.org/>.
054:
055: */
056:
057: package org.jdom;
058:
059: /**
060: * An XML comment. Methods allow the user to get and set the text of the
061: * comment.
062: *
063: * @version $Revision: 1.1 $, $Date: 2005/04/27 09:32:38 $
064: * @author Brett McLaughlin
065: * @author Jason Hunter
066: */
067: public class Comment extends Content {
068:
069: private static final String CVS_ID = "@(#) $RCSfile: Comment.java,v $ $Revision: 1.1 $ $Date: 2005/04/27 09:32:38 $ $Name: $";
070:
071: /** Text of the <code>Comment</code> */
072: protected String text;
073:
074: /**
075: * Default, no-args constructor for implementations to use if needed.
076: */
077: protected Comment() {
078: }
079:
080: /**
081: * This creates the comment with the supplied text.
082: *
083: * @param text <code>String</code> content of comment.
084: */
085: public Comment(String text) {
086: setText(text);
087: }
088:
089: /**
090: * Returns the XPath 1.0 string value of this element, which is the
091: * text of this comment.
092: *
093: * @return the text of this comment
094: */
095: public String getValue() {
096: return text;
097: }
098:
099: /**
100: * This returns the textual data within the <code>Comment</code>.
101: *
102: * @return <code>String</code> - text of comment.
103: */
104: public String getText() {
105: return text;
106: }
107:
108: /**
109: * This will set the value of the <code>Comment</code>.
110: *
111: * @param text <code>String</code> text for comment.
112: * @return <code>Comment</code> - this Comment modified.
113: * @throws IllegalDataException if the given text is illegal for a
114: * Comment.
115: */
116: public Comment setText(String text) {
117: String reason;
118: if ((reason = Verifier.checkCommentData(text)) != null) {
119: throw new IllegalDataException(text, "comment", reason);
120: }
121:
122: this .text = text;
123: return this ;
124: }
125:
126: /**
127: * This returns a <code>String</code> representation of the
128: * <code>Comment</code>, suitable for debugging. If the XML
129: * representation of the <code>Comment</code> is desired,
130: * {@link org.jdom.output.XMLOutputter#outputString(Comment)}
131: * should be used.
132: *
133: * @return <code>String</code> - information about the
134: * <code>Attribute</code>
135: */
136: public String toString() {
137: return new StringBuffer().append("[Comment: ").append(
138: new org.jdom.output.XMLOutputter().outputString(this ))
139: .append("]").toString();
140: }
141:
142: }
|