KickJava   Java API By Example, From Geeks To Geeks.

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


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 class ParameterDescription extends FeatureDescription {
67
68     private TypeDescription mType;
69     private ParameterDescriptor mParameterDescriptor;
70
71     /**
72      * Creates a new ParameterDescription
73      */

74     public ParameterDescription(TypeDescription type,
75                                 ParameterDescriptor pd,
76                                 TeaToolsUtils utils) {
77
78         super(utils);
79
80         mType = type;
81         mParameterDescriptor = pd;
82     }
83
84     /**
85      * Returns the parameter's type
86      */

87     public TypeDescription getType() {
88         return mType;
89     }
90
91     /**
92      * Returns the ParameterDescriptor
93      */

94     public ParameterDescriptor getParameterDescriptor() {
95         return mParameterDescriptor;
96     }
97
98     /**
99      * Returns the formal param name, or null if the formal name is not
100      * available.
101      */

102     public String JavaDoc getName() {
103         String JavaDoc name = super.getName();
104         if (name != null) {
105             if (name.equals(getParameterDescriptor().getDisplayName()) ||
106                 name.length() == 0) {
107                 name = null;
108             }
109         }
110         
111         return name;
112     }
113
114
115     //
116
// FeatureDescription methods
117
//
118

119     public FeatureDescriptor getFeatureDescriptor() {
120         return getParameterDescriptor();
121     }
122
123     public String JavaDoc getShortFormat() {
124         return getType().getShortFormat();
125     }
126
127     public String JavaDoc getLongFormat() {
128         String JavaDoc name = getName();
129         String JavaDoc longFormat = getType().getLongFormat();
130         if (name != null) {
131             longFormat = longFormat + " " + name;
132         }
133
134         return longFormat;
135     }
136
137
138     
139
140 }
141
Popular Tags