abstractdocumentsequence.java

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

package it.unimi.dsi.mg4j.document;

/*		 
 * MG4J: Managing Gigabytes for Java
 *
 * Copyright (C) 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.Util;
import it.unimi.dsi.io.SafelyCloseable;

import java.io.IOException;

import org.apache.log4j.Logger;

/** An abstract, {@link it.unimi.dsi.io.SafelyCloseable safely closeable} implementation of a document sequence. 
 * 
 * <p>Note that even if your {@link DocumentSequence} implementation does not allocate
 * any specific resource, it is nonetheless a good idea to inherit from this class, as tracking
 * missing calls to {@link java.io.Closeable#close() close()} will be easier to detect.
 */
public abstract class AbstractDocumentSequence implements DocumentSequence, SafelyCloseable {
	private static final Logger LOGGER = Util.getLogger( AbstractDocumentSequence.class );
	
	/** Whether this document sequence has already been closed. */
	private boolean closed;

	protected void finalize() throws Throwable {
		try {
			if ( ! closed ) {
				LOGGER.warn( "This " + this.getClass().getName() + " [" + toString() + "] should have been closed." );
				close();
			}
		}
		finally {
			super.finalize();
		}
	}

	public void close() throws IOException {
		closed = true;
	}
}