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 java.io.File;
055: import java.util.Stack;
056:
057: /**
058: * State of the summary loader visitor
059: *
060: *@author Chris Seguin
061: *@created August 30, 1999
062: */
063: public class SummaryLoaderState {
064: private Stack stack;
065: private File file;
066: private int code;
067:
068: /**
069: * Description of the Field
070: */
071: public final static int INITIALIZE = 0;
072: /**
073: * Description of the Field
074: */
075: public final static int LOAD_FILE = 1;
076: /**
077: * Description of the Field
078: */
079: public final static int LOAD_TYPE = 2;
080: /**
081: * Description of the Field
082: */
083: public final static int LOAD_CLASSBODY = 3;
084: /**
085: * Description of the Field
086: */
087: public final static int LOAD_INTERFACE_LIST = 4;
088: /**
089: * Description of the Field
090: */
091: public final static int LOAD_EXCEPTIONS = 5;
092: /**
093: * Description of the Field
094: */
095: public final static int LOAD_PARAMETERS = 6;
096: /**
097: * Description of the Field
098: */
099: public final static int LOAD_METHODBODY = 7;
100: /**
101: * Tells the loader to ignore the structure - used only for counting
102: */
103: public final static int IGNORE = 100;
104:
105: /**
106: * Create a summary loader state
107: */
108: public SummaryLoaderState() {
109: stack = new Stack();
110: file = null;
111: code = INITIALIZE;
112: }
113:
114: /**
115: * Set the current file
116: *
117: *@param next the new file
118: */
119: public void setFile(File next) {
120: file = next;
121: }
122:
123: /**
124: * Set the current code
125: *
126: *@param next The next code
127: */
128: public void setCode(int next) {
129: code = next;
130: }
131:
132: /**
133: * Get the current summary
134: *
135: *@return the current summary
136: */
137: public Summary getCurrentSummary() {
138: if (code == INITIALIZE) {
139: PackageSummary packageSummary = PackageSummary
140: .getPackageSummary("");
141: startSummary(new FileSummary(packageSummary, getFile()));
142: code = LOAD_FILE;
143: }
144:
145: return (Summary) stack.peek();
146: }
147:
148: /**
149: * Get the file
150: *
151: *@return the file
152: */
153: public File getFile() {
154: return file;
155: }
156:
157: /**
158: * Get the current code
159: *
160: *@return The code
161: */
162: public int getCode() {
163: return code;
164: }
165:
166: /**
167: * Set the current summary
168: *
169: *@param next the new current summary
170: */
171: public void startSummary(Summary next) {
172: stack.push(next);
173: }
174:
175: /**
176: * Complete the current summary
177: */
178: public void finishSummary() {
179: stack.pop();
180: }
181: }
|