org.jwall.web.audit.io.AuditEventReader Maven / Gradle / Ivy

Go to download
/*
 *  Copyright (C) 2007-2014 Christian Bockermann 
 *
 *  This file is part of the  web-audit  library.
 *
 *  web-audit library is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  The  web-audit  library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see .
 *
 */
package org.jwall.web.audit.io;

import java.io.IOException;

import org.jwall.web.audit.AuditEvent;


/**
 * 
 * This interface defines the methods of an abstract event-reader. All
 * readers must implement the method readNext() which is
 * used to read the next event from the underlying source (i.e. file).
 * 
 * @author Christian Bockermann <[email protected]>
 *  
 */
public interface AuditEventReader
    extends Iterable
{
	
	/**
	 * This method tries to read the next event that is available. 
	 * 
	 * @return The next audit-event from or NULL if no event is available.
	 */
	public AuditEvent readNext() throws IOException, ParseException;
	
	public void close() throws IOException;
	
	public boolean atEOF();
	
	public long bytesRead();
	
	public long bytesAvailable();
}