abstractindexreader.java

MG4J (Managing Gigabytes for Java) is a free full-text search engine for large document collections

package it.unimi.dsi.mg4j.index;

/*		 
 * MG4J: Managing Gigabytes for Java
 *
 * Copyright (C) 2003-2007 Sebastiano Vigna 
 *
 *  This library is free software; you can redistribute it and/or modify it
 *  under the terms of the GNU Lesser General Public License as published by the Free
 *  Software Foundation; either version 2.1 of the License, or (at your option)
 *  any later version.
 *
 *  This 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 Lesser General Public License
 *  for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *
 */

import it.unimi.dsi.io.SafelyCloseable;
import it.unimi.dsi.Util;

import java.io.IOException;

import org.apache.log4j.Logger;

/** An abstract, {@linkplain SafelyCloseable safely closeable} implementation of an index reader.
 */

public abstract class AbstractIndexReader implements IndexReader {
	private static final Logger LOGGER = Util.getLogger( AbstractIndexReader.class );

	/** Whether this reader has been closed. */
	protected boolean closed;

	public void close() throws IOException {
		closed = true;
	}
	
	protected void finalize() throws Throwable {
		try {
			if ( ! closed ) {
				LOGGER.warn( "This " + this.getClass().getName() + " [" + toString() + "] should have been closed." );
				close();
			}
		}
		finally {
			super.finalize();
		}
	}
	
	/** Throws an {@link UnsupportedOperationException}. */
	
	public IndexIterator nextIterator() throws IOException {
		throw new UnsupportedOperationException();
	}
}