1   /*
    2    * Copyright (c) 2003 The Visigoth Software Society. All rights
    3    * reserved.
    4    *
    5    * Redistribution and use in source and binary forms, with or without
    6    * modification, are permitted provided that the following conditions
    7    * are met:
    8    *
    9    * 1. Redistributions of source code must retain the above copyright
   10    *    notice, this list of conditions and the following disclaimer.
   11    *
   12    * 2. Redistributions in binary form must reproduce the above copyright
   13    *    notice, this list of conditions and the following disclaimer in
   14    *    the documentation and/or other materials provided with the
   15    *    distribution.
   16    *
   17    * 3. The end-user documentation included with the redistribution, if
   18    *    any, must include the following acknowledgement:
   19    *       "This product includes software developed by the
   20    *        Visigoth Software Society (http://www.visigoths.org/)."
   21    *    Alternately, this acknowledgement may appear in the software itself,
   22    *    if and wherever such third-party acknowledgements normally appear.
   23    *
   24    * 4. Neither the name "FreeMarker", "Visigoth", nor any of the names of the 
   25    *    project contributors may be used to endorse or promote products derived
   26    *    from this software without prior written permission. For written
   27    *    permission, please contact visigoths@visigoths.org.
   28    *
   29    * 5. Products derived from this software may not be called "FreeMarker" or "Visigoth"
   30    *    nor may "FreeMarker" or "Visigoth" appear in their names
   31    *    without prior written permission of the Visigoth Software Society.
   32    *
   33    * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   34    * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   35    * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   36    * DISCLAIMED.  IN NO EVENT SHALL THE VISIGOTH SOFTWARE SOCIETY OR
   37    * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   38    * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   39    * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   40    * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   41    * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   42    * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   43    * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   44    * SUCH DAMAGE.
   45    * ====================================================================
   46    *
   47    * This software consists of voluntary contributions made by many
   48    * individuals on behalf of the Visigoth Software Society. For more
   49    * information on the Visigoth Software Society, please see
   50    * http://www.visigoths.org/
   51    */
   52   
   53   package freemarker.debug;
   54   
   55   import java.io.Serializable;
   56   
   57   /**
   58    * Represents a breakpoint location consisting of a template name and a line number.
   59    * @author Attila Szegedi
   60    * @version $Id: Breakpoint.java,v 1.1.2.1 2006/11/27 07:54:19 szegedia Exp $
   61    */
   62   public class Breakpoint implements Serializable, Comparable
   63   {
   64       private static final long serialVersionUID = 1L;
   65   
   66       private final String templateName;
   67       private final int line;
   68       
   69       /**
   70        * Creates a new breakpoint.
   71        * @param templateName the name of the template
   72        * @param line the line number in the template where to put the breakpoint
   73        */
   74       public Breakpoint(String templateName, int line)
   75       {
   76           this.templateName = templateName;
   77           this.line = line;
   78       }
   79   
   80       /**
   81        * Returns the line number of the breakpoint
   82        */
   83       public int getLine()
   84       {
   85           return line;
   86       }
   87       /**
   88        * Returns the template name of the breakpoint
   89        */
   90       public String getTemplateName()
   91       {
   92           return templateName;
   93       }
   94   
   95       public int hashCode()
   96       {
   97           return templateName.hashCode() + 31 * line;
   98       }
   99       
  100       public boolean equals(Object o)
  101       {
  102           if(o instanceof Breakpoint)
  103           {
  104               Breakpoint b = (Breakpoint)o;
  105               return b.templateName.equals(templateName) && b.line == line;
  106           }
  107           return false;
  108       }
  109       
  110       public int compareTo(Object o)
  111       {
  112           Breakpoint b = (Breakpoint)o;
  113           int r = templateName.compareTo(b.templateName);
  114           return r == 0 ? line - b.line : r;
  115       }
  116       
  117       /**
  118        * Returns the template name and the line number separated with a colon
  119        */
  120       public String getLocationString()
  121       {
  122           return templateName + ":" + line;
  123       }
  124   }