ReturnPredicate.java Source File

00001 package edu.ksu.cis.bandera.specification.predicate.datastructure;
00002 
00003 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
00004  * Bandera, a Java(TM) analysis and transformation toolkit           *
00005  * Copyright (C) 2000   Robby (robby@cis.ksu.edu)                    *
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 import java.util.*;
00036 import ca.mcgill.sable.soot.*;
00037 import ca.mcgill.sable.soot.jimple.*;
00038 import edu.ksu.cis.bandera.annotation.*;
00039 import edu.ksu.cis.bandera.jjjc.symboltable.*;
00040 import edu.ksu.cis.bandera.jjjc.symboltable.Package;
00041 import edu.ksu.cis.bandera.specification.predicate.exception.*;
00042 public class ReturnPredicate extends MethodPredicate implements Comparable {
00043     private boolean ret;
00044 /**
00045  * 
00046  * @param name edu.ksu.cis.bandera.jjjc.symboltable.Name
00047  * @param edu.ksu.cis.bandera.jjjc.symboltable.ClassOrInterfaceType type
00048  * @param annotation edu.ksu.cis.bandera.annotation.Annotation
00049  * @param node edu.ksu.cis.bandera.specification.predicate.node.Node
00050  * @param expTable java.util.Hashtable
00051  * @param exceptions java.util.Vector
00052  * @param exact boolean
00053  * @param ret boolean
00054  */
00055 protected ReturnPredicate(Name name, ClassOrInterfaceType type, Annotation annotation, edu.ksu.cis.bandera.specification.predicate.node.Node node, Vector exceptions, boolean ret) throws DuplicatePredicateException {
00056     super(name, type, annotation, node, exceptions);
00057 }
00058 /**
00059  * 
00060  * @return int
00061  * @param o java.lang.Object
00062  */
00063 public int compareTo(Object o) {
00064     if (o instanceof InvokePredicate) {
00065         return 1;
00066     } else if (o instanceof LocationPredicate) {
00067         return 1;
00068     } else if (o instanceof ReturnPredicate) {
00069         return name.compareTo(((ReturnPredicate) o).getName());
00070     } else {
00071         return -1;
00072     }
00073 }
00074 /**
00075  * 
00076  * @return boolean
00077  */
00078 public boolean hasRet() {
00079     return ret;
00080 }
00081 /**
00082  * 
00083  * @return java.lang.String
00084  */
00085 public String toString() {
00086     Object o = ((edu.ksu.cis.bandera.specification.predicate.node.AReturnPropositionDefinition) node).getParams();
00087     String s = "RETURN " + name + "(" + (o != null? o.toString().trim() : "") + ")";
00088     if (constraint == null) return s;
00089     else return s + ": " + constraint.toString().trim();
00090 }
00091 }