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.query;
053:
054: import java.util.Iterator;
055: import org.acm.seguin.summary.TraversalVisitor;
056: import org.acm.seguin.summary.TypeSummary;
057: import org.acm.seguin.summary.FileSummary;
058: import org.acm.seguin.summary.TypeDeclSummary;
059:
060: /**
061: * Searches the set of summaries for all the classes that extend a particular
062: * class.
063: *
064: *@author Chris Seguin
065: *@created September 12, 2001
066: */
067: public class ChildClassSearcher extends TraversalVisitor {
068: /**
069: * Visit a file summary.
070: *
071: *@param node the summary that we are visiting
072: *@param data the data that was passed in
073: *@return the result public Object visit(FileSummary node, Object
074: * data) { if (node.getFile() == null) { return data; } return
075: * super.visit(node, data); }
076: */
077:
078: /**
079: * Visit a file summary.
080: *
081: * Visit a file summary. Visit a type summary.
082: *
083: *@param node the summary that we are visiting
084: *@param data the data that was passed in
085: *@return the result public Object visit(FileSummary node, Object
086: * data) { if (node.getFile() == null) { return data; } return
087: * super.visit(node, data); }
088: *@return the result public Object visit(FileSummary node, Object
089: * data) { if (node.getFile() == null) { return data; } return
090: * super.visit(node, data); }
091: */
092: public Object visit(TypeSummary node, Object data) {
093: SearchData search = (SearchData) data;
094:
095: TypeDeclSummary parentDecl = node.getParentClass();
096: if (parentDecl == null) {
097: return data;
098: }
099: TypeSummary parentTypeSummary = GetTypeSummary
100: .query(parentDecl);
101:
102: if (parentTypeSummary == search.getParentType()) {
103: search.addChild(node);
104: }
105:
106: // Return some value
107: return data;
108: }
109:
110: /**
111: * Generates a list of classes that extend type
112: *
113: *@param type the desired parent class
114: *@return an iterator of type summaries
115: */
116: public static Iterator query(TypeSummary type) {
117: SearchData search = new SearchData(type);
118: (new ChildClassSearcher()).visit(search);
119: return search.getChildren();
120: }
121: }
|