org.hibernate.search.store.DirectoryProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hibernate-annotations

Annotations metadata for Hibernate

There is a newer version: 3.5.6-Final

//$Id: $
package org.hibernate.search.store;

import java.util.Properties;

import org.apache.lucene.store.Directory;


/**
 * Set up and provide a Lucene Directory
 * equals() and hashCode() must guaranty equality
 * between two providers pointing to the same underlying Lucene Store
 * This class must be thread safe regarding getDirectory()
 * calls
 *
 * @author Emmanuel Bernard
 * @author Sylvain Vieujot
 */
public interface DirectoryProvider {
	/**
	 * get the information to initialize the directory and build its hashCode
	 */
	void initialize(String directoryProviderName, Properties properties);

	/**
	 * Returns an initialized Lucene Directory. This method call must be threadsafe
	 */
	TDirectory getDirectory();
}