KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > soot > UnitBox


1 /* Soot - a J*va Optimization Framework
2  * Copyright (C) 1997-1999 Raja Vallee-Rai
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the
16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17  * Boston, MA 02111-1307, USA.
18  */

19
20 /*
21  * Modified by the Sable Research Group and others 1997-1999.
22  * See the 'credits' file distributed with Soot for the complete list of
23  * contributors. (Soot is distributed at http://www.sable.mcgill.ca/soot)
24  */

25
26
27
28
29 package soot;
30
31 import soot.util.*;
32 import java.util.*;
33 import java.io.*;
34
35 /** A box which can contain units.
36  *
37  * @see Unit
38  */

39 public interface UnitBox extends Serializable
40 {
41     /** Sets this box to contain the given unit. Subject to canContainValue() checks. */
42     public void setUnit(Unit u);
43
44     /** Returns the unit contained within this box. */
45     public Unit getUnit();
46
47     /** Returns true if this box can contain the given Unit. */
48     public boolean canContainUnit(Unit u);
49     
50     /**
51      * Returns true if the UnitBox is holding a Unit that is the
52      * target of a branch (ie a Unit at the beginning of a CFG block).
53      * This is the default case.
54      *
55      * <p> Returns false if the UnitBox is holding a Unit that
56      * indicates the end of a CFG block and may require specialised
57      * processing for SSA.
58      **/

59     public boolean isBranchTarget();
60
61     public void toString(UnitPrinter up);
62 }
63
Popular Tags