BaseDirectory

abstract class BaseDirectory : Directory

Base implementation for a concrete Directory that uses a LockFactory for locking.

Inheritors

Properties

Link copied to clipboard

Functions

Link copied to clipboard
abstract override fun close()

Closes the directory.

Link copied to clipboard
open fun copyFrom(from: Directory, src: String, dest: String, context: IOContext)

Copies an existing src file from directory from to a non-existent file dest in this directory. The given IOContext is only used for opening the destination file.

Link copied to clipboard
abstract fun createOutput(name: String, context: IOContext): IndexOutput

Creates a new, empty file in the directory and returns an IndexOutput instance for appending data to this file.

Link copied to clipboard
abstract fun createTempOutput(prefix: String, suffix: String, context: IOContext): IndexOutput

Creates a new, empty, temporary file in the directory and returns an IndexOutput instance for appending data to this file.

Link copied to clipboard
abstract fun deleteFile(name: String)

Removes an existing file in the directory.

Link copied to clipboard
open override fun ensureOpen()

Ensures this directory is still open.

Link copied to clipboard
abstract fun fileLength(name: String): Long

Returns the byte length of a file in the directory.

Link copied to clipboard
abstract fun listAll(): Array<String>

Returns names of all files stored in this directory. The output must be in sorted (UTF-16, java's String.compareTo) order.

Link copied to clipboard
open override fun obtainLock(name: String): Lock

Acquires and returns a Lock for a file with the given name.

Link copied to clipboard

Opens a checksum-computing stream for reading an existing file.

Link copied to clipboard
abstract fun openInput(name: String, context: IOContext): IndexInput

Opens a stream for reading an existing file.

Link copied to clipboard
abstract fun rename(source: String, dest: String)

Renames source file to dest file where dest must not already exist in the directory.

Link copied to clipboard
abstract fun sync(names: MutableCollection<String>)

Ensures that any writes to these files are moved to stable storage (made durable).

Link copied to clipboard
abstract fun syncMetaData()

Ensures that directory metadata, such as recent file renames, are moved to stable storage.

Link copied to clipboard
open override fun toString(): String