core/org.gnit.lucenekmp.codecs/CompoundDirectory

CompoundDirectory

abstract class CompoundDirectory : Directory

A read-only Directory that consists of a view over a compound file.

Properties

pendingDeletions

abstract val pendingDeletions: MutableSet<String>

Functions

checkIntegrity

abstract fun checkIntegrity()

Checks consistency of this directory.

abstract override fun close()

Closes the directory.

copyFrom

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.

createOutput

open override 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.

createTempOutput

open override 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.

deleteFile

open override fun deleteFile(name: String)

Not implemented

ensureOpen

open fun ensureOpen()

Ensures this directory is still open.

fileLength

abstract fun fileLength(name: String): Long

Returns the byte length of a file in the directory.

listAll

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.

obtainLock

open override fun obtainLock(name: String): Lock

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

openChecksumInput

open fun openChecksumInput(name: String): ChecksumIndexInput

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

openInput

abstract fun openInput(name: String, context: IOContext): IndexInput

Opens a stream for reading an existing file.

rename

open override fun rename(from: String, to: String)

Not implemented

sync

open override fun sync(names: MutableCollection<String>)

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

syncMetaData

open override fun syncMetaData()

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

toString

open override fun toString(): String

CompoundDirectory

See also

Properties

Functions