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 * @version $Id: ByLineSource.java 785531 2009-06-17 09:47:59Z ltheussl $
30 */
31 public interface ByLineSource
32 {
33 /**
34 * <p>getNextLine.</p>
35 *
36 * @return the next line. <code>null</code> if we reached the end.
37 * @throws org.apache.maven.doxia.parser.ParseException on I/O error
38 */
39 String getNextLine() throws ParseException;
40
41 /**
42 * <p>getName.</p>
43 *
44 * @return the name of the input. could be the filename for example.
45 */
46 String getName();
47
48 /**
49 * <p>getLineNumber.</p>
50 *
51 * @return the current line number.
52 */
53 int getLineNumber();
54
55 /**
56 * <p>ungetLine.</p>
57 *
58 * This should throw a java.lang.IllegalStateException if called more than
59 * one time without calling getNextLine().
60 */
61 void ungetLine();
62
63
64 /**
65 * <p>unget.</p>
66 *
67 * @param s some text to push back to the parser.
68 * This should throw a java.lang.IllegalStateException if called more than
69 * one time without calling getNextLine().
70 */
71 void unget( String s );
72
73
74 /**
75 * close the source.
76 */
77 void close();
78 }