Index.java Source File

00001 package edu.ksu.cis.bandera.prog;
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 //Index.java
00036 /**
00037  * Represents a program point.  It keeps an integer for the index.
00038  * This is used for the hash code and comparison.
00039  *
00040  * @author <a href="mailto:laubach@cis.ksu.edu">Shawn Laubach</a>
00041  *
00042  * @version 0.1
00043  */
00044 public class Index
00045 {
00046   /**
00047    * The index
00048    */
00049   protected int index;
00050 
00051   /**
00052    * Index constructor.  
00053    *
00054    * @param i the value of the index.
00055    */
00056   public Index(int i)
00057   {
00058     index = i;
00059   }  
00060   /**
00061    * Returns the base index, in this case, itself.
00062    *
00063    * @return The base index.
00064    */
00065   public Index baseIndex()
00066   {
00067     return this;
00068   }  
00069   public boolean equals(Object o)
00070   {
00071     if (getClass() == o.getClass())
00072       return index == ((Index)o).index;
00073     else
00074       return false;
00075   }  
00076   public int hashCode()
00077   {
00078     return index;
00079   }  
00080   /**
00081    * Returns the index value.
00082    *
00083    * @return The index value.
00084    */
00085   public int index()
00086   {
00087     return index;
00088   }  
00089   public String toString()
00090   {
00091     return index + "";
00092   }  
00093 }