001package org.apache.maven.doxia.util; 002 003/* 004 * Licensed to the Apache Software Foundation (ASF) under one 005 * or more contributor license agreements. See the NOTICE file 006 * distributed with this work for additional information 007 * regarding copyright ownership. The ASF licenses this file 008 * to you under the Apache License, Version 2.0 (the 009 * "License"); you may not use this file except in compliance 010 * with the License. You may obtain a copy of the License at 011 * 012 * http://www.apache.org/licenses/LICENSE-2.0 013 * 014 * Unless required by applicable law or agreed to in writing, 015 * software distributed under the License is distributed on an 016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 017 * KIND, either express or implied. See the License for the 018 * specific language governing permissions and limitations 019 * under the License. 020 */ 021 022import org.apache.maven.doxia.parser.ParseException; 023 024/** 025 * The token are the new lines :) 026 * 027 * @author Juan F. Codagnone 028 * @since Nov 4, 2005 029 */ 030public interface ByLineSource 031{ 032 /** 033 * <p>getNextLine.</p> 034 * 035 * @return the next line. <code>null</code> if we reached the end. 036 * @throws org.apache.maven.doxia.parser.ParseException on I/O error 037 */ 038 String getNextLine() throws ParseException; 039 040 /** 041 * <p>getName.</p> 042 * 043 * @return the name of the input. could be the filename for example. 044 */ 045 String getName(); 046 047 /** 048 * <p>getLineNumber.</p> 049 * 050 * @return the current line number. 051 */ 052 int getLineNumber(); 053 054 /** 055 * <p>ungetLine.</p> 056 * 057 * This should throw a java.lang.IllegalStateException if called more than 058 * one time without calling getNextLine(). 059 */ 060 void ungetLine(); 061 062 063 /** 064 * <p>unget.</p> 065 * 066 * @param s some text to push back to the parser. 067 * This should throw a java.lang.IllegalStateException if called more than 068 * one time without calling getNextLine(). 069 */ 070 void unget( String s ); 071 072 073 /** 074 * close the source. 075 */ 076 void close(); 077}