Package org.hibernate.search.backend.lucene.lowlevel.directory.spi

Interface DirectoryHolder

All Superinterfaces:

AutoCloseable, Closeable

public interface DirectoryHolder
extends Closeable

Method Summary

Modifier and Type	Method	Description
void	close()	Release any resource currently held by the DirectoryHolder, including (but not limiting to) the directory itself.
Directory	get()
void	start()	Allocate internal resources (filesystem directories, ...) as necessary, along with the directory itself.

Method Details

start

void start()
    throws IOException

Allocate internal resources (filesystem directories, ...) as necessary, along with the directory itself.

After this method has been called, get() can be safely called.

Throws:

IOException - If an error occurs while creating resources.

RuntimeException - If an error occurs while creating resources.

close

void close()
    throws IOException

Release any resource currently held by the DirectoryHolder, including (but not limiting to) the directory itself.

After this method has been called, the result of calling any other method on the same instance is undefined.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException - If an error occurs while releasing resources.

RuntimeException - If an error occurs while releasing resources.

get

Directory get()

Returns:

The directory held by this DirectoryHolder.