001: /*
002: * Copyright (c) 2003 The Visigoth Software Society. All rights
003: * reserved.
004: *
005: * Redistribution and use in source and binary forms, with or without
006: * modification, are permitted provided that the following conditions
007: * are met:
008: *
009: * 1. Redistributions of source code must retain the above copyright
010: * notice, this list of conditions and the following disclaimer.
011: *
012: * 2. Redistributions in binary form must reproduce the above copyright
013: * notice, this list of conditions and the following disclaimer in
014: * the documentation and/or other materials provided with the
015: * distribution.
016: *
017: * 3. The end-user documentation included with the redistribution, if
018: * any, must include the following acknowledgement:
019: * "This product includes software developed by the
020: * Visigoth Software Society (http://www.visigoths.org/)."
021: * Alternately, this acknowledgement may appear in the software itself,
022: * if and wherever such third-party acknowledgements normally appear.
023: *
024: * 4. Neither the name "FreeMarker", "Visigoth", nor any of the names of the
025: * project contributors may be used to endorse or promote products derived
026: * from this software without prior written permission. For written
027: * permission, please contact visigoths@visigoths.org.
028: *
029: * 5. Products derived from this software may not be called "FreeMarker" or "Visigoth"
030: * nor may "FreeMarker" or "Visigoth" appear in their names
031: * without prior written permission of the Visigoth Software Society.
032: *
033: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
034: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
035: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
036: * DISCLAIMED. IN NO EVENT SHALL THE VISIGOTH SOFTWARE SOCIETY OR
037: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
038: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
039: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
040: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
041: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
042: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
043: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
044: * SUCH DAMAGE.
045: * ====================================================================
046: *
047: * This software consists of voluntary contributions made by many
048: * individuals on behalf of the Visigoth Software Society. For more
049: * information on the Visigoth Software Society, please see
050: * http://www.visigoths.org/
051: */
052:
053: package freemarker.debug;
054:
055: import java.io.Serializable;
056:
057: /**
058: * Represents a breakpoint location consisting of a template name and a line number.
059: * @author Attila Szegedi
060: * @version $Id: Breakpoint.java,v 1.1.2.1 2006/11/27 07:54:19 szegedia Exp $
061: */
062: public class Breakpoint implements Serializable, Comparable {
063: private static final long serialVersionUID = 1L;
064:
065: private final String templateName;
066: private final int line;
067:
068: /**
069: * Creates a new breakpoint.
070: * @param templateName the name of the template
071: * @param line the line number in the template where to put the breakpoint
072: */
073: public Breakpoint(String templateName, int line) {
074: this .templateName = templateName;
075: this .line = line;
076: }
077:
078: /**
079: * Returns the line number of the breakpoint
080: */
081: public int getLine() {
082: return line;
083: }
084:
085: /**
086: * Returns the template name of the breakpoint
087: */
088: public String getTemplateName() {
089: return templateName;
090: }
091:
092: public int hashCode() {
093: return templateName.hashCode() + 31 * line;
094: }
095:
096: public boolean equals(Object o) {
097: if (o instanceof Breakpoint) {
098: Breakpoint b = (Breakpoint) o;
099: return b.templateName.equals(templateName)
100: && b.line == line;
101: }
102: return false;
103: }
104:
105: public int compareTo(Object o) {
106: Breakpoint b = (Breakpoint) o;
107: int r = templateName.compareTo(b.templateName);
108: return r == 0 ? line - b.line : r;
109: }
110:
111: /**
112: * Returns the template name and the line number separated with a colon
113: */
114: public String getLocationString() {
115: return templateName + ":" + line;
116: }
117: }
|