1 /**
2 * Redistribution and use of this software and associated documentation ("Software"), with or
3 * without modification, are permitted provided that the following conditions are met:
4 *
5 * 1. Redistributions of source code must retain copyright statements and notices. Redistributions
6 * must also contain a copy of this document.
7 *
8 * 2. Redistributions in binary form must reproduce the above copyright notice, this list of
9 * conditions and the following disclaimer in the documentation and/or other materials provided with
10 * the distribution.
11 *
12 * 3. The name "Exolab" must not be used to endorse or promote products derived from this Software
13 * without prior written permission of Intalio, Inc. For written permission, please contact
14 * info@exolab.org.
15 *
16 * 4. Products derived from this Software may not be called "Exolab" nor may "Exolab" appear in
17 * their names without prior written permission of Intalio, Inc. Exolab is a registered trademark of
18 * Intalio, Inc.
19 *
20 * 5. Due credit should be given to the Exolab Project (http://www.exolab.org/).
21 *
22 * THIS SOFTWARE IS PROVIDED BY INTALIO, INC. AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESSED OR
23 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
24 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTALIO, INC. OR ITS
25 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
29 * WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 *
31 * Copyright 1999 (C) Intalio, Inc. All Rights Reserved.
32 */
33 package org.exolab.javasource;
34
35 /**
36 * Represents a parameter to a JMethod.
37 *
38 * @author <a href="mailto:keith AT kvisco DOT com">Keith Visco</a>
39 * @version $Revision$ $Date: 2005-03-05 06:42:06 -0700 (Sat, 05 Mar 2005) $
40 */
41 public final class JParameter extends JAnnotatedElementHelper {
42 // --------------------------------------------------------------------------
43
44 /** The type associated with this JParameter. */
45 private JType _type;
46
47 /** The name of this JParameter. */
48 private String _name;
49
50 // --------------------------------------------------------------------------
51
52 /**
53 * Creates a new JParameter with the given type, and name.
54 *
55 * @param type The JType to associate with this JParameter.
56 * @param name Name of the JParameter.
57 */
58 public JParameter(final JType type, final String name) {
59 super();
60
61 setType(type);
62 setName(name);
63 }
64
65 // --------------------------------------------------------------------------
66
67 /**
68 * Returns the name of the parameter.
69 *
70 * @return The name of the parameter.
71 */
72 public String getName() {
73 return _name;
74 }
75
76 /**
77 * Returns the parameter type.
78 *
79 * @return The parameter type.
80 */
81 public JType getType() {
82 return _type;
83 }
84
85 /**
86 * Sets the name of this parameter.
87 *
88 * @param name The new name of the parameter.
89 */
90 public void setName(final String name) {
91 _name = name;
92 }
93
94 /**
95 * Sets the type of this parameter.
96 *
97 * @param type The new JType of this parameter.
98 */
99 public void setType(final JType type) {
100 if (type == null) {
101 String err = "A Parameter cannot have a null type.";
102 throw new IllegalArgumentException(err);
103 }
104 _type = type;
105 }
106
107 // --------------------------------------------------------------------------
108
109 /**
110 * {@inheritDoc} <br/>
111 * Returns the String representation of this JParameter. The String returned will consist of the
112 * String representation of the parameter type followed by the name of the parameter.
113 */
114 public String toString() {
115 return new StringBuilder().append("final ").append(_type).append(' ').append(_name).toString();
116 }
117
118 // --------------------------------------------------------------------------
119 }