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.ASTName;
055: import org.acm.seguin.summary.query.GetTypeSummary;
056:
057: /**
058: * Summarize a message send summary.
059: *
060: *@author Chris Seguin
061: *@created June 23, 1999
062: */
063: public class MessageSendSummary extends Summary {
064: // Instance Variables
065: private String objectName;
066: private String packageName;
067: private String messageName;
068: private String first;
069:
070: /**
071: * Creates a message send summary from an ASTName object.
072: *
073: *@param parentSummary the parent summary
074: *@param nameNode the ASTName object
075: */
076: public MessageSendSummary(Summary parentSummary, ASTName nameNode) {
077: // Initialize the parent class
078: super (parentSummary);
079:
080: // Initialize the variables
081: messageName = null;
082: objectName = null;
083: packageName = null;
084:
085: // Local Variables
086: int numChildren = nameNode.getNameSize();
087:
088: // Determine the name of the message
089: messageName = nameNode.getNamePart(numChildren - 1).intern();
090:
091: // Determine the name of the object (or class)
092: if (numChildren > 1) {
093: first = nameNode.getNamePart(0);
094: objectName = nameNode.getNamePart(numChildren - 2).intern();
095:
096: // Extract the package
097: if (numChildren > 2) {
098: StringBuffer buffer = new StringBuffer(nameNode
099: .getNamePart(0));
100: for (int ndx = 1; ndx < numChildren - 2; ndx++) {
101: buffer.append(".");
102: buffer.append(nameNode.getNamePart(ndx));
103: }
104: packageName = buffer.toString().intern();
105: }
106: } else {
107: first = null;
108: }
109: }
110:
111: /**
112: * Get the package name
113: *
114: *@return a string containing the name of the package
115: */
116: public String getPackageName() {
117: return packageName;
118: }
119:
120: /**
121: * Get the name of the type
122: *
123: *@return a string containing the name of the type
124: */
125: public String getObjectName() {
126: return objectName;
127: }
128:
129: /**
130: * Get the name of the type
131: *
132: *@return a string containing the name of the type
133: */
134: public String getMessageName() {
135: return messageName;
136: }
137:
138: /**
139: * Gets a type declaration if this reference is to a package and type pair
140: *
141: *@return the summary
142: */
143: public TypeDeclSummary getTypeDecl() {
144: if (packageName == null) {
145: if (objectName != null) {
146: TypeDeclSummary result = new TypeDeclSummary(this ,
147: packageName, objectName);
148: TypeSummary test = GetTypeSummary.query(result);
149: if (test != null) {
150: return result;
151: }
152: }
153: return null;
154: }
155:
156: return new TypeDeclSummary(this , packageName, objectName);
157: }
158:
159: /**
160: * Gets the Name attribute of the MessageSendSummary object
161: *
162: *@return The Name value
163: */
164: public String getName() {
165: return toString();
166: }
167:
168: /**
169: * Convert this into a string
170: *
171: *@return a string representation of the type
172: */
173: public String toString() {
174: // Start with the long name
175: StringBuffer buffer = new StringBuffer();
176:
177: if (packageName != null) {
178: buffer.append(packageName);
179: buffer.append(".");
180: }
181:
182: if (objectName != null) {
183: buffer.append(objectName);
184: buffer.append(".");
185: }
186:
187: buffer.append(messageName);
188: buffer.append("()");
189:
190: return buffer.toString();
191: }
192:
193: /**
194: * Provide method to visit a node
195: *
196: *@param visitor the visitor
197: *@param data the data for the visit
198: *@return some new data
199: */
200: public Object accept(SummaryVisitor visitor, Object data) {
201: return visitor.visit(this , data);
202: }
203:
204: /**
205: * Check to see if it is equal
206: *
207: *@param other the other item
208: *@return true if they are equal
209: */
210: public boolean equals(Object other) {
211: if (other instanceof MessageSendSummary) {
212: MessageSendSummary mss = (MessageSendSummary) other;
213:
214: boolean sameObject = ((objectName == null) && (mss.objectName == null))
215: || ((objectName != null) && objectName
216: .equals(mss.objectName));
217:
218: boolean samePackage = ((packageName == null) && (mss.packageName == null))
219: || ((packageName != null) && packageName
220: .equals(mss.packageName));
221:
222: boolean sameMessage = ((messageName == null) && (mss.messageName == null))
223: || ((messageName != null) && messageName
224: .equals(mss.messageName));
225:
226: return sameObject && samePackage && sameMessage;
227: }
228: return super .equals(other);
229: }
230:
231: /**
232: * Gets the firstObject attribute of the MessageSendSummary object
233: *
234: *@return The firstObject value
235: */
236: public String getFirstObject() {
237: return first;
238: }
239: }
|