Main Page   Packages   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  

WorkList.java

00001 package edu.ksu.cis.bandera.bofa;
00002 
00003 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
00004  * Bandera, a Java(TM) analysis and transformation toolkit           *
00005  * Copyright (C) 1998, 1999   Shawn Laubach (laubach@acm.org)        *
00006  * All rights reserved.                                              *
00007  *                                                                   *
00008  * This work was done as a project in the SAnToS Laboratory,         *
00009  * Department of Computing and Information Sciences, Kansas State    *
00010  * University, USA (http://www.cis.ksu.edu/santos).                  *
00011  * It is understood that any modification not identified as such is  *
00012  * not covered by the preceding statement.                           *
00013  *                                                                   *
00014  * This work is free software; you can redistribute it and/or        *
00015  * modify it under the terms of the GNU Library General Public       *
00016  * License as published by the Free Software Foundation; either      *
00017  * version 2 of the License, or (at your option) any later version.  *
00018  *                                                                   *
00019  * This work is distributed in the hope that it will be useful,      *
00020  * but WITHOUT ANY WARRANTY; without even the implied warranty of    *
00021  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU *
00022  * Library General Public License for more details.                  *
00023  *                                                                   *
00024  * You should have received a copy of the GNU Library General Public *
00025  * License along with this toolkit; if not, write to the             *
00026  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,      *
00027  * Boston, MA  02111-1307, USA.                                      *
00028  *                                                                   *
00029  * Java is a trademark of Sun Microsystems, Inc.                     *
00030  *                                                                   *
00031  * To submit a bug report, send a comment, or get the latest news on *
00032  * this project and other SAnToS projects, please visit the web-site *
00033  *                http://www.cis.ksu.edu/santos                      *
00034  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
00035 
00036 import java.util.LinkedList;
00037 import java.util.Iterator;
00038 
00039 /* 
00040  * WorkList.java 
00041  * $Id: WorkList.java,v 1.1.1.1 2002/01/24 03:42:08 pserver Exp $
00042  */
00043 
00044 /**
00045  * This class represents the work list algorithm to be used in the flow analysis.
00046  *
00047  * @author <A HREF="http://www.cis.ksu.edu/~hatcliff">John Hatcliff</A>
00048  * @author
00049  * <a href="http://www.cis.ksu.edu/~rvprasad">Venkatesh Prasad Ranganath</a> 
00050  * @version $Name:  $($Revision: 1.1.1.1 $)
00051  */
00052 public class WorkList 
00053 {
00054     /** 
00055      * List of work. 
00056      */
00057     private LinkedList list = null;
00058 
00059     /**
00060      * Constructor of the class. 
00061      */
00062     public WorkList()
00063     {
00064         list = new LinkedList();
00065     }
00066     /**
00067      * Empty the work list.  Any existing work piece are lost.
00068      *
00069      */
00070     public void clear() {
00071         list.clear();
00072     }
00073     /**
00074      * Executes the work in the work list.
00075      */
00076     public void doWork()
00077     {
00078         FGWork w;
00079 
00080         while (!this.isEmpty()) {
00081             w = this.remove();
00082             w.doWork();
00083         }
00084     }
00085     /**
00086      * Inserts new work into the list.
00087      * 
00088      * @param work the new work to be added to the list. 
00089      */
00090     public void insert(FGWork work)
00091     {
00092         list.addLast(work);
00093     }
00094     /**
00095      * Tells whether the work list is empty.
00096      *
00097      * @return true if the worklist is empty, false otherwise. 
00098      */
00099     public boolean isEmpty()
00100     {
00101         return list.isEmpty();
00102     }
00103     /**
00104      * Provides an iterator for the list.
00105      *
00106      * @return an iterator for the list. 
00107      */
00108     public Iterator iterator()
00109     {
00110         return list.iterator();
00111     }
00112     /**
00113      * Provides the current work in the list.
00114      *
00115      * @return the current work in the list. 
00116      */
00117     public FGWork remove()
00118     {
00119         return (FGWork) list.removeFirst();
00120     }
00121 }

Generated at Thu Feb 7 06:59:19 2002 for Bandera by doxygen1.2.10 written by Dimitri van Heesch, © 1997-2001