001: /* ====================================================================
002: * The JRefactory License, Version 1.0
003: *
004: * Copyright (c) 2001 JRefactory. All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions
008: * are met:
009: *
010: * 1. Redistributions of source code must retain the above copyright
011: * notice, this list of conditions and the following disclaimer.
012: *
013: * 2. Redistributions in binary form must reproduce the above copyright
014: * notice, this list of conditions and the following disclaimer in
015: * the documentation and/or other materials provided with the
016: * distribution.
017: *
018: * 3. The end-user documentation included with the redistribution,
019: * if any, must include the following acknowledgment:
020: * "This product includes software developed by the
021: * JRefactory (http://www.sourceforge.org/projects/jrefactory)."
022: * Alternately, this acknowledgment may appear in the software itself,
023: * if and wherever such third-party acknowledgments normally appear.
024: *
025: * 4. The names "JRefactory" must not be used to endorse or promote
026: * products derived from this software without prior written
027: * permission. For written permission, please contact seguin@acm.org.
028: *
029: * 5. Products derived from this software may not be called "JRefactory",
030: * nor may "JRefactory" appear in their name, without prior written
031: * permission of Chris Seguin.
032: *
033: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
034: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
035: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
036: * DISCLAIMED. IN NO EVENT SHALL THE CHRIS SEGUIN OR
037: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
038: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
039: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
040: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
041: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
042: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
043: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
044: * SUCH DAMAGE.
045: * ====================================================================
046: *
047: * This software consists of voluntary contributions made by many
048: * individuals on behalf of JRefactory. For more information on
049: * JRefactory, please see
050: * <http://www.sourceforge.org/projects/jrefactory>.
051: */
052: package org.acm.seguin.summary;
053:
054: import net.sourceforge.jrefactory.ast.ASTType;
055: import net.sourceforge.jrefactory.ast.ASTVariableDeclaratorId;
056:
057: /**
058: * Stores information about a method
059: *
060: *@author Chris Seguin
061: *@created June 8, 1999
062: */
063: public class VariableSummary extends Summary {
064: // Instance Variables
065: private String name;
066: private TypeDeclSummary type;
067: private StringBuffer declaration = null;
068:
069: /**
070: * Construct a method from a method declaration node
071: *
072: *@param parentSummary the parent summary
073: *@param id The id of the variable
074: *@param typeNode Description of Parameter
075: */
076: public VariableSummary(Summary parentSummary, ASTType typeNode,
077: ASTVariableDeclaratorId id) {
078: // Initialize the parent class
079: super (parentSummary);
080:
081: // Remember the name
082: name = id.getName().intern();
083:
084: // Remember the type
085: type = TypeDeclSummary.getTypeDeclSummary(this , typeNode);
086:
087: // Rememeber the array count
088: type.setArrayCount(type.getArrayCount() + id.getArrayCount());
089: }
090:
091: /**
092: * Create a variable for debugging purposes
093: *
094: *@param parentSummary Description of Parameter
095: *@param type Description of Parameter
096: *@param name Description of Parameter
097: */
098: public VariableSummary(Summary parentSummary, TypeDeclSummary type,
099: String name) {
100: // Initialize the parent class
101: super (parentSummary);
102:
103: // Remember the name
104: this .name = name;
105:
106: // Remember the type
107: this .type = type;
108: }
109:
110: /**
111: * Sets the name
112: *
113: *@param value the name of the field
114: */
115: public void setName(String value) {
116: name = value;
117: }
118:
119: /**
120: * Return the name
121: *
122: *@return the name of the method
123: */
124: public String getName() {
125: return name;
126: }
127:
128: /**
129: * Return the type as a string
130: *
131: *@return the name of the method
132: */
133: public String getType() {
134: return type.toString();
135: }
136:
137: /**
138: * Return the type as a type summary
139: *
140: *@return the type summary
141: */
142: public TypeDeclSummary getTypeDecl() {
143: return type;
144: }
145:
146: /**
147: * Convert this to a string
148: *
149: *@return a string representation of this object
150: */
151: public String getDeclaration() {
152: if (declaration == null) {
153: declaration = new StringBuffer();
154: }
155: declaration.setLength(0);
156: declaration.append(type.getName());
157: declaration.append(" ");
158: declaration.append(getName());
159: return declaration.toString();
160: }
161:
162: /**
163: * Convert this to a string
164: *
165: *@return a string representation of this object
166: */
167: public String toString() {
168: return getName() + ":" + getType();
169: }
170:
171: /**
172: * Provide method to visit a node
173: *
174: *@param visitor the visitor
175: *@param data the data for the visit
176: *@return some new data
177: */
178: public Object accept(SummaryVisitor visitor, Object data) {
179: return visitor.visit(this, data);
180: }
181: }
|