---

ClassTokenManaged.java

package edu.ksu.cis.bandera.bofa;

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 * Bandera, a Java(TM) analysis and transformation toolkit           *
 * Copyright (C) 1998, 1999   Shawn Laubach (laubach@acm.org)        *
 * All rights reserved.                                              *
 *                                                                   *
 * This work was done as a project in the SAnToS Laboratory,         *
 * Department of Computing and Information Sciences, Kansas State    *
 * University, USA (http://www.cis.ksu.edu/santos).                  *
 * It is understood that any modification not identified as such is  *
 * not covered by the preceding statement.                           *
 *                                                                   *
 * This work is free software; you can redistribute it and/or        *
 * modify it under the terms of the GNU Library General Public       *
 * License as published by the Free Software Foundation; either      *
 * version 2 of the License, or (at your option) any later version.  *
 *                                                                   *
 * This work is distributed in the hope that it will be useful,      *
 * but WITHOUT ANY WARRANTY; without even the implied warranty of    *
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU *
 * Library General Public License for more details.                  *
 *                                                                   *
 * You should have received a copy of the GNU Library General Public *
 * License along with this toolkit; if not, write to the             *
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,      *
 * Boston, MA  02111-1307, USA.                                      *
 *                                                                   *
 * Java is a trademark of Sun Microsystems, Inc.                     *
 *                                                                   *
 * To submit a bug report, send a comment, or get the latest news on *
 * this project and other SAnToS projects, please visit the web-site *
 *                http://www.cis.ksu.edu/santos                      *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

import ca.mcgill.sable.soot.*;
import ca.mcgill.sable.util.*;

/**
 * Class represents classes that are being managed by the Analysis and are not
 * array classes.
 * @author <A HREF="http://www.cis.ksu.edu/~hatcliff">John Hatcliff</A>
 * @author <a href="http://www.cis.ksu.edu/~rvprasad">Venkatesh Prasad Ranganath
 * </a> 
 */

public class ClassTokenManaged implements ClassToken
{
    /* ***************** */
    /* static components */
    /* ***************** */

    /**
     * Maps SootClass objects to ClassToken objects.
     */
    private static Map allocatedTokens = new HashMap();

    /**
     * ClassToken representing the type of the unknown values.  Basically the
     * values which we will not cover in the analysis.
     */
    final public static ClassTokenManaged unknownClassToken = 
        new ClassTokenManaged(new SootClass("unknownClassToken"));
    
    /** The Class token corresponding to the Null object. It is reasonable to
     * use the same Class Token for all null references.*/
    public final static ClassTokenManaged nullClassToken =
         new ClassTokenManaged(new SootClass("BOFA_NullValue"));
    /**
     * dump the SootClass to ClassToken mapping for unknown values.
     */
    static {
        allocatedTokens.put(unknownClassToken.getSootClass(),
                            unknownClassToken);
        allocatedTokens.put(nullClassToken.getSootClass(),
                            nullClassToken);
    }

    /* ******************* */
    /* instance components */
    /* ******************* */

    /**
     * the SootClass this object is associated with.
     */
    SootClass sootClass;


    /**
     * Constructor for the class
     */
    private ClassTokenManaged(SootClass sootClass)
    {
        this.sootClass = sootClass;
    }
    /**
     * Returns a string to be displayed in the GUI.
     * @return the string to dump
     */
    public String display() 
    {
        return this.sootClass.getName();
    }
    /**
     * Returns a string used in debugging dumps. 
     * @return the string to dump
     */
    public String dump()
    {
        return display();
    }
    /**
     * Returns the SootClass associated with this class token
     * @return the SootClass 
     */
    public SootClass getSootClass()
    {
        return this.sootClass;
    }
    /**
     * Retrieves the ClassToken object corresponding to the SootClass.  If a
     * ClassToken is not associated, a new object is created and associated.
     * @param sootClass the soot class for which the class token is requested.
     * @return the class token corresponding to the soot class.  */
    public static ClassTokenManaged select(Object sootClass)
    {
        if (allocatedTokens.containsKey(sootClass)) {
            return (ClassTokenManaged) allocatedTokens.get(sootClass);
        } else {
            ClassTokenManaged classToken 
                = new ClassTokenManaged((SootClass) sootClass);
            allocatedTokens.put(sootClass,classToken);
            return classToken;
        }
    }
}

---