public abstract class FilterDirectory extends Directory
Directory implementation such as
NRTCachingDirectory or to add additional
sanity checks for tests. However, if you plan to write your own
Directory implementation, you should consider extending directly
Directory or BaseDirectory rather than try to reuse
functionality of existing Directorys by extending this class.| Modifier | Constructor and Description |
|---|---|
protected |
FilterDirectory(Directory in)
Sole constructor, typically called from sub-classes.
|
| Modifier and Type | Method and Description |
|---|---|
void |
close()
Closes the store.
|
IndexOutput |
createOutput(String name,
IOContext context)
Creates a new, empty file in the directory with the given name.
|
IndexOutput |
createTempOutput(String prefix,
String suffix,
IOContext context)
Creates a new, empty file for writing in the directory, with a
temporary file name including prefix and suffix, ending with the
reserved extension
.tmp. |
void |
deleteFile(String name)
Removes an existing file in the directory.
|
long |
fileLength(String name)
Returns the length of a file in the directory.
|
Directory |
getDelegate()
Return the wrapped
Directory. |
String[] |
listAll()
Returns an array of strings, one for each entry in the directory, in sorted (UTF16, java's String.compare) order.
|
Lock |
obtainLock(String name)
Returns an obtained
Lock. |
IndexInput |
openInput(String name,
IOContext context)
Returns a stream reading an existing file.
|
void |
renameFile(String source,
String dest)
Renames
source to dest as an atomic operation,
where dest does not yet exist in the directory. |
void |
sync(Collection<String> names)
Ensure that any writes to these files are moved to
stable storage.
|
String |
toString() |
static Directory |
unwrap(Directory dir)
Get the wrapped instance by
dir as long as this reader is
an instance of FilterDirectory. |
copyFrom, ensureOpen, openChecksumInputprotected final Directory in
protected FilterDirectory(Directory in)
public static Directory unwrap(Directory dir)
dir as long as this reader is
an instance of FilterDirectory.public String[] listAll() throws IOException
DirectorylistAll in class DirectoryIOException - in case of IO errorpublic void deleteFile(String name) throws IOException
DirectorydeleteFile in class DirectoryIOExceptionpublic long fileLength(String name) throws IOException
DirectoryFileNotFoundException or NoSuchFileException
if the file does not exist.
fileLength in class Directoryname - the name of the file for which to return the length.IOException - if there was an IO error while retrieving the file's
length.public IndexOutput createOutput(String name, IOContext context) throws IOException
DirectorycreateOutput in class DirectoryIOExceptionpublic IndexOutput createTempOutput(String prefix, String suffix, IOContext context) throws IOException
Directory.tmp. Use
IndexOutput.getName() to see what name was used.createTempOutput in class DirectoryIOExceptionpublic void sync(Collection<String> names) throws IOException
Directorysync in class DirectoryIOExceptionpublic void renameFile(String source, String dest) throws IOException
Directorysource to dest as an atomic operation,
where dest does not yet exist in the directory.
Notes: This method is used by IndexWriter to publish commits.
It is ok if this operation is not truly atomic, for example
both source and dest can be visible temporarily.
It is just important that the contents of dest appear
atomically, or an exception is thrown.
renameFile in class DirectoryIOExceptionpublic IndexInput openInput(String name, IOContext context) throws IOException
DirectoryThrows FileNotFoundException or NoSuchFileException
if the file does not exist.
openInput in class DirectoryIOExceptionpublic Lock obtainLock(String name) throws IOException
DirectoryLock.obtainLock in class Directoryname - the name of the lock fileLockObtainFailedException - (optional specific exception) if the lock could
not be obtained because it is currently held elsewhere.IOException - if any i/o error occurs attempting to gain the lockpublic void close()
throws IOException
Directoryclose in interface Closeableclose in interface AutoCloseableclose in class DirectoryIOExceptionCopyright © 2000-2016 Apache Software Foundation. All Rights Reserved.