001: /**
002: * Redistribution and use of this software and associated documentation
003: * ("Software"), with or without modification, are permitted provided
004: * that the following conditions are met:
005: *
006: * 1. Redistributions of source code must retain copyright
007: * statements and notices. Redistributions must also contain a
008: * copy of this document.
009: *
010: * 2. Redistributions in binary form must reproduce the
011: * above copyright notice, this list of conditions and the
012: * following disclaimer in the documentation and/or other
013: * materials provided with the distribution.
014: *
015: * 3. The name "Exolab" must not be used to endorse or promote
016: * products derived from this Software without prior written
017: * permission of Intalio, Inc. For written permission,
018: * please contact info@exolab.org.
019: *
020: * 4. Products derived from this Software may not be called "Exolab"
021: * nor may "Exolab" appear in their names without prior written
022: * permission of Intalio, Inc. Exolab is a registered
023: * trademark of Intalio, Inc.
024: *
025: * 5. Due credit should be given to the Exolab Project
026: * (http://www.exolab.org/).
027: *
028: * THIS SOFTWARE IS PROVIDED BY INTALIO, INC. AND CONTRIBUTORS
029: * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
030: * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
031: * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
032: * INTALIO, INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
033: * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
034: * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
035: * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
036: * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
037: * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
038: * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
039: * OF THE POSSIBILITY OF SUCH DAMAGE.
040: *
041: * Copyright 1999 (C) Intalio, Inc. All Rights Reserved.
042: */package org.exolab.javasource;
043:
044: /**
045: * Represents a parameter to a JMethod.
046: *
047: * @author <a href="mailto:keith AT kvisco DOT com">Keith Visco</a>
048: * @version $Revision: 6675 $ $Date: 2005-03-05 06:42:06 -0700 (Sat, 05 Mar 2005) $
049: */
050: public final class JParameter extends JAnnotatedElementHelper {
051: //--------------------------------------------------------------------------
052:
053: /** The type associated with this JParameter. */
054: private JType _type;
055:
056: /** The name of this JParameter. */
057: private String _name;
058:
059: //--------------------------------------------------------------------------
060:
061: /**
062: * Creates a new JParameter with the given type, and name.
063: *
064: * @param type The JType to associate with this JParameter.
065: * @param name Name of the JParameter.
066: */
067: public JParameter(final JType type, final String name) {
068: super ();
069:
070: setType(type);
071: setName(name);
072: }
073:
074: //--------------------------------------------------------------------------
075:
076: /**
077: * Returns the name of the parameter.
078: *
079: * @return The name of the parameter.
080: */
081: public String getName() {
082: return _name;
083: }
084:
085: /**
086: * Returns the parameter type.
087: *
088: * @return The parameter type.
089: */
090: public JType getType() {
091: return _type;
092: }
093:
094: /**
095: * Sets the name of this parameter.
096: *
097: * @param name The new name of the parameter.
098: */
099: public void setName(final String name) {
100: _name = name;
101: }
102:
103: /**
104: * Sets the type of this parameter.
105: *
106: * @param type The new JType of this parameter.
107: */
108: public void setType(final JType type) {
109: if (type == null) {
110: String err = "A Parameter cannot have a null type.";
111: throw new IllegalArgumentException(err);
112: }
113: _type = type;
114: }
115:
116: //--------------------------------------------------------------------------
117:
118: /**
119: * {@inheritDoc}
120: * <br/>
121: * Returns the String representation of this JParameter. The String returned
122: * will consist of the String representation of the parameter type followed
123: * by the name of the parameter.
124: */
125: public String toString() {
126: StringBuffer sb = new StringBuffer();
127: sb.append("final ");
128: sb.append(_type.toString());
129: sb.append(' ');
130: sb.append(_name);
131: return sb.toString();
132: }
133:
134: //--------------------------------------------------------------------------
135: }
|