1 package org.apache.maven.doxia.util;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 import org.apache.maven.doxia.parser.ParseException;
23
24 /**
25 * The token are the new lines :)
26 *
27 * @author Juan F. Codagnone
28 * @since Nov 4, 2005
29 */
30 public interface ByLineSource
31 {
32 /**
33 * <p>getNextLine.</p>
34 *
35 * @return the next line. <code>null</code> if we reached the end.
36 * @throws org.apache.maven.doxia.parser.ParseException on I/O error
37 */
38 String getNextLine() throws ParseException;
39
40 /**
41 * <p>getName.</p>
42 *
43 * @return the name of the input. could be the filename for example.
44 */
45 String getName();
46
47 /**
48 * <p>getLineNumber.</p>
49 *
50 * @return the current line number.
51 */
52 int getLineNumber();
53
54 /**
55 * <p>ungetLine.</p>
56 *
57 * This should throw a java.lang.IllegalStateException if called more than
58 * one time without calling getNextLine().
59 */
60 void ungetLine();
61
62
63 /**
64 * <p>unget.</p>
65 *
66 * @param s some text to push back to the parser.
67 * This should throw a java.lang.IllegalStateException if called more than
68 * one time without calling getNextLine().
69 */
70 void unget( String s );
71
72
73 /**
74 * close the source.
75 */
76 void close();
77 }