KickJava   Java API By Example, From Geeks To Geeks.

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


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 import java.io.*;
56
57 /******************************************************************************
58  * LinePositionReader aids in printing line numbers for error reporting.
59  *
60  * @author Brian S O'Neill
61  * @version
62  * <!--$$Revision:--> 17 <!-- $-->, <!--$$JustDate:--> 12/11/00 <!-- $-->
63  */

64 public class LinePositionReader extends PositionReader {
65     private int mLineNumber = 1;
66     private int mPushback = -1;
67
68     public LinePositionReader(Reader reader) {
69         super(reader);
70     }
71
72     public int read() throws IOException {
73         int c;
74
75         if (mPushback >= 0) {
76             c = mPushback;
77             mPushback = -1;
78         }
79         else {
80             c = super.read();
81         }
82
83         if (c == '\n') {
84             mLineNumber++;
85         }
86         else if (c == '\r') {
87             int peek = super.read();
88             if (peek != '\n') {
89                 mLineNumber++;
90             }
91             mPushback = peek;
92         }
93
94         return c;
95     }
96
97     /**
98      * After calling readLine, calling getLineNumber returns the next line
99      * number.
100      */

101     public String JavaDoc readLine() throws IOException {
102         StringBuffer JavaDoc buf = new StringBuffer JavaDoc(80);
103         int line = mLineNumber;
104         int c;
105         while (line == mLineNumber && (c = read()) >= 0) {
106             buf.append((char)c);
107         }
108         return buf.toString();
109     }
110
111     /**
112      * Skips forward into the stream to the line number specified. The line
113      * can then be read by calling readLine. Calling getPosition
114      * returns the position that the line begins.
115      *
116      * @return the line number reached
117      */

118     public int skipForwardToLine(int line) throws IOException {
119         while (mLineNumber < line && read() >= 0) {}
120         return mLineNumber;
121     }
122
123     /**
124      * @return the number of the line currently being read or the next one
125      * available.
126      */

127     public int getLineNumber() {
128         return mLineNumber;
129     }
130
131     /**
132      * Converts all whitespace characters in a String to space characters
133      * ( ).
134      */

135     public static String JavaDoc cleanWhitespace(String JavaDoc str) {
136         int length = str.length();
137
138         StringBuffer JavaDoc buf = new StringBuffer JavaDoc(length);
139         for (int i=0; i<length; i++) {
140             char c = str.charAt(i);
141             if (Character.isWhitespace(c)) {
142                 buf.append(' ');
143             }
144             else {
145                 buf.append(c);
146             }
147         }
148
149         return buf.toString();
150     }
151
152     /**
153      * Creates and returns a String containing a sequence of the specified
154      * length, repeating the given character.
155      */

156     public static String JavaDoc createSequence(char c, int length) {
157         if (length < 0) length = 1;
158
159         StringBuffer JavaDoc buf = new StringBuffer JavaDoc(length);
160         for (; length > 0; length--) {
161             buf.append(c);
162         }
163         return buf.toString();
164     }
165 }
166
Popular Tags