The NIOFSDirectory type exposes the following members.

Methods

  NameDescription
Public methodClearLock
Attempt to clear (forcefully unlock and remove) the specified lock. Only call this at a time when you are certain this lock is no longer in use.
(Inherited from Directory.)
Public methodClose
Closes the store to future operations.
(Inherited from FSDirectory.)
Public methodCreateOutput
Creates an IndexOutput for the file with the given name. In 3.0 this method will become abstract.
(Inherited from FSDirectory.)
Public methodDeleteFile
Removes an existing file in the directory.
(Inherited from FSDirectory.)
Public methodDispose
.NET
(Inherited from FSDirectory.)
Public methodEnsureOpen (Inherited from Directory.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodFileExists
Returns true iff a file with the given name exists.
(Inherited from FSDirectory.)
Public methodFileLength
Returns the length in bytes of a file in the directory.
(Inherited from FSDirectory.)
Public methodFileModified(String)
Returns the time the named file was last modified.
(Inherited from FSDirectory.)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetDirectory()()()() (Inherited from FSDirectory.)
Public methodGetFile Obsolete. (Inherited from FSDirectory.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetLockFactory
Get the LockFactory that this Directory instance is using for its locking implementation. Note that this may be null for Directory implementations that provide their own locking implementation.
(Inherited from Directory.)
Public methodGetLockID (Inherited from FSDirectory.)
Public methodGetReadChunkSize
The maximum number of bytes to read at once from the underlying file during {@link IndexInput#readBytes}.
(Inherited from FSDirectory.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodInitOutput
Initializes the directory to create a new file with the given name. This method should be used in {@link #createOutput}.
(Inherited from FSDirectory.)
Public methodList Obsolete. (Inherited from FSDirectory.)
Public methodListAll()()()()
Lists all files (not subdirectories) in the directory.
(Inherited from FSDirectory.)
Public methodMakeLock
Construct a {@link Lock}.
(Inherited from Directory.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodOpenInput(String) (Inherited from FSDirectory.)
Public methodOpenInput(String, Int32)
Creates an IndexInput for the file with the given name. In 3.0 this method will become abstract.
(Inherited from FSDirectory.)
Public methodRenameFile Obsolete.
Renames an existing file in the directory. Warning: This is not atomic.
(Inherited from FSDirectory.)
Public methodSetLockFactory
Set the LockFactory that this Directory instance should use for its locking implementation. Each * instance of LockFactory should only be used for one directory (ie, do not share a single instance across multiple Directories).
(Inherited from Directory.)
Public methodSetReadChunkSize
Sets the maximum number of bytes read at once from the underlying file during {@link IndexInput#readBytes}. The default value is {@link #DEFAULT_READ_CHUNK_SIZE};

This was introduced due to Sun JVM Bug 6478546, which throws an incorrect OutOfMemoryError when attempting to read too many bytes at once. It only happens on 32bit JVMs with a large maximum heap size.

Changes to this value will not impact any already-opened {@link IndexInput}s. You should call this before attempting to open an index on the directory.

NOTE: This value should be as large as possible to reduce any possible performance impact. If you still encounter an incorrect OutOfMemoryError, trying lowering the chunk size.

(Inherited from FSDirectory.)
Public methodSync (Inherited from FSDirectory.)
Public methodToString
For debug output.
(Inherited from FSDirectory.)
Public methodTouchFile
Set the modified time of an existing file to now.
(Inherited from FSDirectory.)

See Also