KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > go > trove > io > SourceInfo


1 /* ====================================================================
2  * Trove - Copyright (c) 1997-2000 Walt Disney Internet Group
3  * ====================================================================
4  * The Tea Software License, Version 1.1
5  *
6  * Copyright (c) 2000 Walt Disney Internet Group. All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * 3. The end-user documentation included with the redistribution,
21  * if any, must include the following acknowledgment:
22  * "This product includes software developed by the
23  * Walt Disney Internet Group (http://opensource.go.com/)."
24  * Alternately, this acknowledgment may appear in the software itself,
25  * if and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. The names "Tea", "TeaServlet", "Kettle", "Trove" and "BeanDoc" must
28  * not be used to endorse or promote products derived from this
29  * software without prior written permission. For written
30  * permission, please contact opensource@dig.com.
31  *
32  * 5. Products derived from this software may not be called "Tea",
33  * "TeaServlet", "Kettle" or "Trove", nor may "Tea", "TeaServlet",
34  * "Kettle", "Trove" or "BeanDoc" appear in their name, without prior
35  * written permission of the Walt Disney Internet Group.
36  *
37  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40  * DISCLAIMED. IN NO EVENT SHALL THE WALT DISNEY INTERNET GROUP OR ITS
41  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
42  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
43  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
44  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
45  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
46  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
47  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
48  * ====================================================================
49  *
50  * For more information about Tea, please see http://opensource.go.com/.
51  */

52
53 package com.go.trove.io;
54
55 /******************************************************************************
56  * Provides information on where an object (like a token) appeared in the
57  * the source file.
58  *
59  * @author Brian S O'Neill
60  * @version
61  * <!--$$Revision:--> 17 <!-- $-->, <!--$$JustDate:--> 12/11/00 <!-- $-->
62  */

63 public class SourceInfo implements Cloneable JavaDoc, java.io.Serializable JavaDoc {
64     private int mLine;
65     private int mStartPosition;
66     private int mEndPosition;
67
68     public SourceInfo(int line, int startPos, int endPos) {
69         mLine = line;
70         mStartPosition = startPos;
71         mEndPosition = endPos;
72     }
73
74     /**
75      * @return The line in the source file. The first line is one.
76      */

77     public int getLine() {
78         return mLine;
79     }
80     
81     /**
82      * @return The character position in the source file where this object
83      * started. The first position of the source file is zero.
84      */

85     public int getStartPosition() {
86         return mStartPosition;
87     }
88
89     /**
90      * @return The character position in the source file where this object
91      * ended. The first position of the source file is zero.
92      */

93     public int getEndPosition() {
94         return mEndPosition;
95     }
96
97     /**
98      * @return A character position detailing this object. Usually is the same
99      * as the start position.
100      */

101     public int getDetailPosition() {
102         return mStartPosition;
103     }
104
105     private SourceInfo copy() {
106         try {
107             return (SourceInfo)super.clone();
108         }
109         catch (CloneNotSupportedException JavaDoc e) {
110             // Should never happen
111
throw new RuntimeException JavaDoc(e.toString());
112         }
113     }
114
115     /**
116      * @return A clone of this SourceInfo, but with a different end position
117      */

118     public SourceInfo setEndPosition(int endPos) {
119         SourceInfo infoCopy = copy();
120         infoCopy.mEndPosition = endPos;
121         return infoCopy;
122     }
123
124     /**
125      * @return A clone of this SourceInfo, but with a different end position
126      */

127     public SourceInfo setEndPosition(SourceInfo info) {
128         return setEndPosition(info.getEndPosition());
129     }
130
131     public String JavaDoc toString() {
132         StringBuffer JavaDoc buf = new StringBuffer JavaDoc(60);
133
134         buf.append("line=");
135         buf.append(getLine());
136         buf.append(',');
137         buf.append("start=");
138         buf.append(getStartPosition());
139         buf.append(',');
140         buf.append("end=");
141         buf.append(getEndPosition());
142         buf.append(',');
143         buf.append("detail=");
144         buf.append(getDetailPosition());
145
146         return buf.toString();
147     }
148 }
149
Popular Tags