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@exolab.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.exolab.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 package org.exolab.javasource;
44
45 /**
46 * Represents a parameter to a JMethod.
47 *
48 * @author <a href="mailto:keith AT kvisco DOT com">Keith Visco</a>
49 * @version $Revision$ $Date: 2005-03-05 06:42:06 -0700 (Sat, 05 Mar 2005) $
50 */
51 public final class JParameter extends JAnnotatedElementHelper {
52 //--------------------------------------------------------------------------
53
54 /** The type associated with this JParameter. */
55 private JType _type;
56
57 /** The name of this JParameter. */
58 private String _name;
59
60 //--------------------------------------------------------------------------
61
62 /**
63 * Creates a new JParameter with the given type, and name.
64 *
65 * @param type The JType to associate with this JParameter.
66 * @param name Name of the JParameter.
67 */
68 public JParameter(final JType type, final String name) {
69 super();
70
71 setType(type);
72 setName(name);
73 }
74
75 //--------------------------------------------------------------------------
76
77 /**
78 * Returns the name of the parameter.
79 *
80 * @return The name of the parameter.
81 */
82 public String getName() {
83 return _name;
84 }
85
86 /**
87 * Returns the parameter type.
88 *
89 * @return The parameter type.
90 */
91 public JType getType() {
92 return _type;
93 }
94
95 /**
96 * Sets the name of this parameter.
97 *
98 * @param name The new name of the parameter.
99 */
100 public void setName(final String name) {
101 _name = name;
102 }
103
104 /**
105 * Sets the type of this parameter.
106 *
107 * @param type The new JType of this parameter.
108 */
109 public void setType(final JType type) {
110 if (type == null) {
111 String err = "A Parameter cannot have a null type.";
112 throw new IllegalArgumentException(err);
113 }
114 _type = type;
115 }
116
117 //--------------------------------------------------------------------------
118
119 /**
120 * {@inheritDoc}
121 * <br/>
122 * Returns the String representation of this JParameter. The String returned
123 * will consist of the String representation of the parameter type followed
124 * by the name of the parameter.
125 */
126 public String toString() {
127 StringBuilder sb = new StringBuilder();
128 sb.append("final ");
129 sb.append(_type.toString());
130 sb.append(' ');
131 sb.append(_name);
132 return sb.toString();
133 }
134
135 //--------------------------------------------------------------------------
136 }