KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > go > teatools > FeatureDescription


1 /* ====================================================================
2  * TeaTools - 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" and "GO.com" must
28  * 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" or "Trove", nor may "Tea", "TeaServlet",
34  * "Kettle" or "Trove" 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.teatools;
54
55 import com.go.trove.classfile.AccessFlags;
56
57 import java.beans.*;
58 import java.lang.reflect.*;
59
60 /******************************************************************************
61  *
62  * @author Mark Masse
63  * @version
64  * <!--$$Revision:--> 1 <!-- $-->, <!--$$JustDate:--> 11/09/00 <!-- $-->
65  */
66 public abstract class FeatureDescription {
67
68     private TeaToolsUtils mUtils;
69
70     public FeatureDescription(TeaToolsUtils utils) {
71         mUtils = utils;
72     }
73
74     public TeaToolsUtils getTeaToolsUtils() {
75         return mUtils;
76     }
77
78     /**
79      * Returns the feature name
80      */
81     public String JavaDoc getName() {
82         FeatureDescriptor fd = getFeatureDescriptor();
83         if (fd == null) {
84             return null;
85         }
86
87         return fd.getName();
88     }
89
90     /**
91      * Returns the shortDescription or "" if the
92      * shortDescription is the same as the displayName.
93      */
94     public String JavaDoc getDescription() {
95         FeatureDescriptor fd = getFeatureDescriptor();
96         if (fd == null) {
97             return "";
98         }
99
100         return getTeaToolsUtils().getDescription(fd);
101     }
102
103     /**
104      * Returns the first sentence of the
105      * shortDescription. Returns "" if the shortDescription is the same as
106      * the displayName (the default for reflection-generated
107      * FeatureDescriptors).
108      */
109     public String JavaDoc getDescriptionFirstSentence() {
110         FeatureDescriptor fd = getFeatureDescriptor();
111         if (fd == null) {
112             return "";
113         }
114
115         return getTeaToolsUtils().getDescriptionFirstSentence(fd);
116     }
117
118
119     public String JavaDoc toString() {
120         return getLongFormat();
121     }
122
123
124     /**
125      * Returns the FeatureDescriptor that is wrapped by this
126      * FeatureDescription
127      */
128     public abstract FeatureDescriptor getFeatureDescriptor();
129
130     /**
131      * Returns a short format String for this FeatureDescription
132      */
133     public abstract String JavaDoc getShortFormat();
134
135     /**
136      * Returns a long format String for this FeatureDescription
137      */
138     public abstract String JavaDoc getLongFormat();
139
140
141 }
142
Popular Tags