Mercurial > repos > pfrommolt > ngsrich

comparison NGSrich_0.5.5/src/org/jdom/Comment.java @ 0:89ad0a9cca52 default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Uploaded
author pfrommolt
date Mon, 21 Nov 2011 08:12:19 -0500
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:89ad0a9cca52
1 /*--
2
3 $Id: Comment.java,v 1.33 2007/11/10 05:28:58 jhunter Exp $
4
5 Copyright (C) 2000-2007 Jason Hunter & Brett McLaughlin.
6 All rights reserved.
7
8 Redistribution and use in source and binary forms, with or without
9 modification, are permitted provided that the following conditions
10 are met:
11
12 1. Redistributions of source code must retain the above copyright
13 notice, this list of conditions, and the following disclaimer.
14
15 2. Redistributions in binary form must reproduce the above copyright
16 notice, this list of conditions, and the disclaimer that follows
17 these conditions in the documentation and/or other materials
18 provided with the distribution.
19
20 3. The name "JDOM" must not be used to endorse or promote products
21 derived from this software without prior written permission. For
22 written permission, please contact <request_AT_jdom_DOT_org>.
23
24 4. Products derived from this software may not be called "JDOM", nor
25 may "JDOM" appear in their name, without prior written permission
26 from the JDOM Project Management <request_AT_jdom_DOT_org>.
27
28 In addition, we request (but do not require) that you include in the
29 end-user documentation provided with the redistribution and/or in the
30 software itself an acknowledgement equivalent to the following:
31 "This product includes software developed by the
32 JDOM Project (http://www.jdom.org/)."
33 Alternatively, the acknowledgment may be graphical using the logos
34 available at http://www.jdom.org/images/logos.
35
36 THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37 WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39 DISCLAIMED. IN NO EVENT SHALL THE JDOM AUTHORS OR THE PROJECT
40 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43 USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47 SUCH DAMAGE.
48
49 This software consists of voluntary contributions made by many
50 individuals on behalf of the JDOM Project and was originally
51 created by Jason Hunter <jhunter_AT_jdom_DOT_org> and
52 Brett McLaughlin <brett_AT_jdom_DOT_org>. For more information
53 on the JDOM Project, please see <http://www.jdom.org/>.
54
55 */
56
57 package org.jdom;
58
59 /**
60 * An XML comment. Methods allow the user to get and set the text of the
61 * comment.
62 *
63 * @version $Revision: 1.33 $, $Date: 2007/11/10 05:28:58 $
64 * @author Brett McLaughlin
65 * @author Jason Hunter
66 */
67 public class Comment extends Content {
68
69 private static final String CVS_ID =
70 "@(#) $RCSfile: Comment.java,v $ $Revision: 1.33 $ $Date: 2007/11/10 05:28:58 $ $Name: jdom_1_1_1 $";
71
72 /** Text of the <code>Comment</code> */
73 protected String text;
74
75 /**
76 * Default, no-args constructor for implementations to use if needed.
77 */
78 protected Comment() {}
79
80 /**
81 * This creates the comment with the supplied text.
82 *
83 * @param text <code>String</code> content of comment.
84 */
85 public Comment(String text) {
86 setText(text);
87 }
88
89
90 /**
91 * Returns the XPath 1.0 string value of this element, which is the
92 * text of this comment.
93 *
94 * @return the text of this comment
95 */
96 public String getValue() {
97 return text;
98 }
99
100 /**
101 * This returns the textual data within the <code>Comment</code>.
102 *
103 * @return <code>String</code> - text of comment.
104 */
105 public String getText() {
106 return text;
107 }
108
109 /**
110 * This will set the value of the <code>Comment</code>.
111 *
112 * @param text <code>String</code> text for comment.
113 * @return <code>Comment</code> - this Comment modified.
114 * @throws IllegalDataException if the given text is illegal for a
115 * Comment.
116 */
117 public Comment setText(String text) {
118 String reason;
119 if ((reason = Verifier.checkCommentData(text)) != null) {
120 throw new IllegalDataException(text, "comment", reason);
121 }
122
123 this.text = text;
124 return this;
125 }
126
127 /**
128 * This returns a <code>String</code> representation of the
129 * <code>Comment</code>, suitable for debugging. If the XML
130 * representation of the <code>Comment</code> is desired,
131 * {@link org.jdom.output.XMLOutputter#outputString(Comment)}
132 * should be used.
133 *
134 * @return <code>String</code> - information about the
135 * <code>Attribute</code>
136 */
137 public String toString() {
138 return new StringBuffer()
139 .append("[Comment: ")
140 .append(new org.jdom.output.XMLOutputter().outputString(this))
141 .append("]")
142 .toString();
143 }
144
145 }