KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jfree > xml > generator > model > Comments


1 /* ========================================================================
2  * JCommon : a free general purpose class library for the Java(tm) platform
3  * ========================================================================
4  *
5  * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors.
6  *
7  * Project Info: http://www.jfree.org/jcommon/index.html
8  *
9  * This library is free software; you can redistribute it and/or modify it
10  * under the terms of the GNU Lesser General Public License as published by
11  * the Free Software Foundation; either version 2.1 of the License, or
12  * (at your option) any later version.
13  *
14  * This library is distributed in the hope that it will be useful, but
15  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
16  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
17  * License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public
20  * License along with this library; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
22  * USA.
23  *
24  * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
25  * in the United States and other countries.]
26  *
27  * -------------
28  * Comments.java
29  * -------------
30  * (C)opyright 2003, 2004, by Thomas Morgner and Contributors.
31  *
32  * Original Author: Thomas Morgner;
33  * Contributor(s): David Gilbert (for Object Refinery Limited);
34  *
35  * $Id: Comments.java,v 1.2 2005/10/18 13:32:37 mungady Exp $
36  *
37  * Changes
38  * -------
39  * 03-Dec-2003 : Initial version (TM);
40  * 04-Feb-2004 : Added Javadocs (DG);
41  *
42  */

43
44 package org.jfree.xml.generator.model;
45
46 /**
47  * A set of comments for a model.
48  */

49 public class Comments {
50     
51     /** Open tag comments. */
52     private String JavaDoc[] openTagComment;
53     
54     /** Close tag comments. */
55     private String JavaDoc[] closeTagComment;
56  
57     /**
58      * Creates a new set of comments.
59      *
60      * @param openTagComment the open tag comment.
61      * @param closeTagComment the close tag comment.
62      */

63     public Comments(final String JavaDoc[] openTagComment, final String JavaDoc[] closeTagComment) {
64         this.openTagComment = openTagComment;
65         this.closeTagComment = closeTagComment;
66     }
67
68     /**
69      * Returns the open tag comments.
70      *
71      * @return The open tag comments.
72      */

73     public String JavaDoc[] getOpenTagComment() {
74         return this.openTagComment;
75     }
76
77     /**
78      * Returns the close tag comments.
79      *
80      * @return The close tag comments.
81      */

82     public String JavaDoc[] getCloseTagComment() {
83         return this.closeTagComment;
84     }
85
86     /**
87      * Returns a string representation of the set of comments.
88      *
89      * @return A string.
90      */

91     public String JavaDoc toString() {
92         final StringBuffer JavaDoc b = new StringBuffer JavaDoc();
93         b.append ("Comments:={open=");
94         if (this.openTagComment == null) {
95             b.append("null");
96         }
97         else {
98             b.append("{");
99             for (int i = 0; i < this.openTagComment.length; i++) {
100                 b.append("[");
101                 b.append(this.openTagComment[i]);
102                 b.append("]");
103             }
104             b.append("}");
105         }
106         b.append(", close=");
107         if (this.closeTagComment == null) {
108             b.append("null");
109         }
110         else {
111             b.append("{");
112             for (int i = 0; i < this.closeTagComment.length; i++) {
113                 b.append("[");
114                 b.append(this.closeTagComment[i]);
115                 b.append("]");
116             }
117             b.append("}");
118         }
119         b.append("}");
120         return b.toString();
121     }
122     
123 }
124
Popular Tags