KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > go > beandoc > teadoc > Tag


1 /* ====================================================================
2  * BeanDoc - Copyright (c) 1997-2000 GO.com
3  * ====================================================================
4  * The Tea Software License, Version 1.0
5  *
6  * Copyright (c) 2000 GO.com. 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 following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * 3. The end-user documentation included with the redistribution,
21  * if any, must include the following acknowledgment:
22  * "This product includes software developed by GO.com
23  * (http://opensource.go.com/)."
24  * Alternately, this acknowledgment may appear in the software itself,
25  * if and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. The names "Tea", "TeaServlet", "Kettle", "Trove", BeanDoc and "GO.com"
28  * must not be used to endorse or promote products derived from this
29  * software without prior written permission. For written
30  * permission, please contact opensource@go.com.
31  *
32  * 5. Products derived from this software may not be called "Tea",
33  * "TeaServlet", "Kettle", "Trove" or BeanDoc, nor may "Tea", "TeaServlet",
34  * "Kettle", "Trove" or BeanDoc appear in their name, without prior written
35  * permission of GO.com.
36  *
37  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40  * DISCLAIMED. IN NO EVENT SHALL GO.COM OR ITS CONTRIBUTORS BE LIABLE
41  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
42  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
43  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
44  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
45  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
46  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
47  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
48  * ====================================================================
49  *
50  * For more information about Tea, please see http://opensource.go.com/.
51  */
52
53 package com.go.beandoc.teadoc;
54
55 /******************************************************************************
56  *
57  * @author Brian S O'Neill
58  * @version
59  * <!--$$Revision:--> 3 <!-- $-->, <!--$$JustDate:--> 8/23/00 <!-- $-->
60  */
61 public class Tag implements java.io.Serializable JavaDoc {
62
63     protected RootDoc mRootDoc;
64
65     private com.sun.javadoc.Tag mTag;
66
67     public static Tag[] convert(RootDoc root, com.sun.javadoc.Tag[] tags) {
68         int length = tags.length;
69         Tag[] newTags = new Tag[length];
70         for (int i=0; i<length; i++) {
71             newTags[i] = new Tag(root, tags[i]);
72         }
73         return newTags;
74     }
75
76     public Tag(RootDoc root, com.sun.javadoc.Tag tag) {
77         mRootDoc = root;
78         mTag = tag;
79     }
80
81     public RootDoc getRootDoc() {
82         return mRootDoc;
83     }
84
85     public String JavaDoc getName() {
86         return mTag.name();
87     }
88
89     public String JavaDoc getKind() {
90         return mTag.kind();
91     }
92
93     public String JavaDoc getText() {
94         return mTag.text();
95     }
96
97     public String JavaDoc toString() {
98         return mTag.toString();
99     }
100
101     public Tag[] getInlineTags() {
102         return convert(mRootDoc, mTag.inlineTags());
103     }
104
105     public Tag[] getFirstSentenceTags() {
106         return convert(mRootDoc, mTag.firstSentenceTags());
107     }
108 }
109
Popular Tags