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 * @version $Id: ByLineSource.html 905940 2014-04-12 16:27:29Z hboutemy $ 030 */ 031public interface ByLineSource 032{ 033 /** 034 * <p>getNextLine.</p> 035 * 036 * @return the next line. <code>null</code> if we reached the end. 037 * @throws org.apache.maven.doxia.parser.ParseException on I/O error 038 */ 039 String getNextLine() throws ParseException; 040 041 /** 042 * <p>getName.</p> 043 * 044 * @return the name of the input. could be the filename for example. 045 */ 046 String getName(); 047 048 /** 049 * <p>getLineNumber.</p> 050 * 051 * @return the current line number. 052 */ 053 int getLineNumber(); 054 055 /** 056 * <p>ungetLine.</p> 057 * 058 * This should throw a java.lang.IllegalStateException if called more than 059 * one time without calling getNextLine(). 060 */ 061 void ungetLine(); 062 063 064 /** 065 * <p>unget.</p> 066 * 067 * @param s some text to push back to the parser. 068 * This should throw a java.lang.IllegalStateException if called more than 069 * one time without calling getNextLine(). 070 */ 071 void unget( String s ); 072 073 074 /** 075 * close the source. 076 */ 077 void close(); 078}