KickJava   Java API By Example, From Geeks To Geeks.

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


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 Parameter implements java.io.Serializable JavaDoc {
62
63     protected RootDoc mRootDoc;
64
65     private com.sun.javadoc.Parameter mParam;
66
67     public static Parameter[] convert(RootDoc root,
68                                       com.sun.javadoc.Parameter[] params) {
69         int length = params.length;
70         Parameter[] newParams = new Parameter[length];
71         for (int i=0; i<length; i++) {
72             newParams[i] = new Parameter(root, params[i]);
73         }
74         return newParams;
75     }
76
77     public Parameter(RootDoc root, com.sun.javadoc.Parameter param) {
78         mRootDoc = root;
79         mParam = param;
80     }
81
82     public RootDoc getRootDoc() {
83         return mRootDoc;
84     }
85
86     public Type getType() {
87         return new Type(mRootDoc, mParam.type());
88     }
89
90     public String JavaDoc getName() {
91         return mParam.name();
92     }
93
94     public String JavaDoc getTypeName() {
95         return mParam.typeName();
96     }
97
98     public String JavaDoc toString() {
99         return mParam.toString();
100     }
101 }
102
Popular Tags