1 /**
2 * Redistribution and use of this software and associated documentation
3 * ("Software"), with or without modification, are permitted provided
4 * that the following conditions are met:
5 *
6 * 1. Redistributions of source code must retain copyright
7 * statements and notices. Redistributions must also contain a
8 * copy of this document.
9 *
10 * 2. Redistributions in binary form must reproduce the
11 * above copyright notice, this list of conditions and the
12 * following disclaimer in the documentation and/or other
13 * materials provided with the distribution.
14 *
15 * 3. The name "Exolab" must not be used to endorse or promote
16 * products derived from this Software without prior written
17 * permission of Intalio, Inc. For written permission,
18 * please contact info@codehaus.org.
19 *
20 * 4. Products derived from this Software may not be called "Exolab"
21 * nor may "Exolab" appear in their names without prior written
22 * permission of Intalio, Inc. Exolab is a registered
23 * trademark of Intalio, Inc.
24 *
25 * 5. Due credit should be given to the Exolab Project
26 * (http://www.codehaus.org/).
27 *
28 * THIS SOFTWARE IS PROVIDED BY INTALIO, INC. AND CONTRIBUTORS
29 * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
30 * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
31 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
32 * INTALIO, INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
33 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
34 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
35 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
37 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
39 * OF THE POSSIBILITY OF SUCH DAMAGE.
40 *
41 * Copyright 1999 (C) Intalio, Inc. All Rights Reserved.
42 *
43 * $Id$
44 */
45 package org.codehaus.modello.plugin.java.javasource;
46
47 /*
48 * Copyright (c) 2004, Codehaus.org
49 *
50 * Permission is hereby granted, free of charge, to any person obtaining a copy of
51 * this software and associated documentation files (the "Software"), to deal in
52 * the Software without restriction, including without limitation the rights to
53 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
54 * of the Software, and to permit persons to whom the Software is furnished to do
55 * so, subject to the following conditions:
56 *
57 * The above copyright notice and this permission notice shall be included in all
58 * copies or substantial portions of the Software.
59 *
60 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
61 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
62 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
63 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
64 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
65 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
66 * SOFTWARE.
67 */
68
69 /**
70 * Represents a parameter to a JMethod.
71 * @author <a href="mailto:kvisco@intalio.com">Keith Visco</a>
72 * @version $Revision$ $Date$
73 **/
74 public class JParameter {
75
76 /**
77 * The type associated with this JParameter
78 **/
79 private JType type = null;
80
81 /**
82 * The name of this JParameter
83 **/
84 private String name = null;
85
86 private JAnnotations annotations = null;
87
88 /**
89 * Creates a new JParameter with the given type, and name
90 * @param type the type to associate with this JParameter
91 * @param name the name of the JParameter
92 **/
93 public JParameter(JType type, String name) throws IllegalArgumentException {
94 super();
95 setType(type);
96 setName(name);
97 } // -- JParameter
98
99 /**
100 * Returns the name of the parameter
101 * @return the name of the parameter
102 **/
103 public String getName() {
104 return this.name;
105 } // -- getName
106
107 /**
108 * Returns the parameter type
109 * @return the parameter type
110 **/
111 public JType getType() {
112 return this.type;
113 } // -- getType
114
115 /**
116 * Sets the name of this parameter
117 * @param name the new name of the parameter
118 **/
119 public void setName(String name) {
120 this.name = name;
121 } // -- setName
122
123 /**
124 * Sets the type of this parameter
125 * @param type the new type of this parameter
126 **/
127 public void setType(JType type) throws IllegalArgumentException {
128 if (type == null) {
129 String err = "A Parameter cannot have a null type.";
130 throw new IllegalArgumentException(err);
131 }
132 this.type = type;
133 } // -- setType
134
135 /**
136 * Returns the String representation of this JParameter. The
137 * String returns will consist of the String representation
138 * of the parameter type, followed by the name of the parameter
139 * @return the String representation of this JParameter
140 **/
141 public String toString() {
142 StringBuilder sb = new StringBuilder();
143 if (annotations != null) {
144 sb.append(annotations.toString());
145 sb.append(' ');
146 }
147 sb.append(this.type.toString());
148 sb.append(' ');
149 sb.append(this.name);
150 return sb.toString();
151 } // -- toString
152
153 /**
154 * @return the annotations
155 */
156 public JAnnotations getAnnotations() {
157 return annotations;
158 }
159
160 /**
161 * @param annotation the annotation to append
162 */
163 public void appendAnnotation(String annotation) {
164 if (annotations == null) {
165 annotations = new JAnnotations();
166 }
167 annotations.appendAnnotation(annotation);
168 }
169
170 /**
171 * @param annotations the annotations to set
172 */
173 public void setAnnotations(JAnnotations annotations) {
174 this.annotations = annotations;
175 }
176 } // -- JParamater