openrs2/org.openrs2.cache/Cache

Cache

class Cache : Flushable, Closeable

A high-level interface for reading and writing files to and from a collection of JS5 archives.

Types

Companion

object Companion

Functions

capacity

fun capacity(archive: Int): Int

fun capacity(archive: Int, group: Int): Int

fun capacity(archive: Int, group: String): Int

capacityNamed

fun capacityNamed(archive: Int, groupNameHash: Int): Int

clear

fun clear()

Writes pending changes back to the underlying Store and clears the internal group cache.

open override fun close()

create

fun create(archive: Int)

exists

fun exists(archive: Int): Boolean

fun exists(archive: Int, group: Int): Boolean

fun exists(archive: Int, group: String): Boolean

fun exists(archive: Int, group: Int, file: Int): Boolean

fun exists(archive: Int, group: String, file: Int): Boolean

fun exists(archive: Int, group: String, file: String): Boolean

existsNamed

fun existsNamed(archive: Int, groupNameHash: Int): Boolean

fun existsNamed(archive: Int, groupNameHash: Int, fileNameHash: Int): Boolean

existsNamedGroup

fun existsNamedGroup(archive: Int, groupNameHash: Int, file: Int): Boolean

flush

open override fun flush()

Writes pending changes back to the underlying Store.

list

fun list(): Iterator<Int>

fun list(archive: Int): Iterator<Js5Index.Group<*>>

fun list(archive: Int, group: Int): Iterator<Js5Index.File>

fun list(archive: Int, group: String): Iterator<Js5Index.File>

listNamed

fun listNamed(archive: Int, groupNameHash: Int): Iterator<Js5Index.File>

read

@JvmOverloads

fun read(archive: Int, group: Int, file: Int, key: SymmetricKey = SymmetricKey.ZERO): ByteBuf

@JvmOverloads

fun read(archive: Int, group: String, file: Int, key: SymmetricKey = SymmetricKey.ZERO): ByteBuf

@JvmOverloads

fun read(archive: Int, group: String, file: String, key: SymmetricKey = SymmetricKey.ZERO): ByteBuf

readNamed

@JvmOverloads

fun readNamed(archive: Int, groupNameHash: Int, fileNameHash: Int, key: SymmetricKey = SymmetricKey.ZERO): ByteBuf

readNamedGroup

@JvmOverloads

fun readNamedGroup(archive: Int, groupNameHash: Int, file: Int, key: SymmetricKey = SymmetricKey.ZERO): ByteBuf

remove

fun remove(archive: Int)

fun remove(archive: Int, group: Int)

fun remove(archive: Int, group: String)

@JvmOverloads

fun remove(archive: Int, group: Int, file: Int, key: SymmetricKey = SymmetricKey.ZERO)

@JvmOverloads

fun remove(archive: Int, group: String, file: Int, key: SymmetricKey = SymmetricKey.ZERO)

@JvmOverloads

fun remove(archive: Int, group: String, file: String, key: SymmetricKey = SymmetricKey.ZERO)

removeNamed

fun removeNamed(archive: Int, groupNameHash: Int)

@JvmOverloads

fun removeNamed(archive: Int, groupNameHash: Int, fileNameHash: Int, key: SymmetricKey = SymmetricKey.ZERO)

removeNamedGroup

@JvmOverloads

fun removeNamedGroup(archive: Int, groupNameHash: Int, file: Int, key: SymmetricKey = SymmetricKey.ZERO)

write

@JvmOverloads

fun write(archive: Int, group: Int, file: Int, buf: ByteBuf, key: SymmetricKey = SymmetricKey.ZERO)

@JvmOverloads

fun write(archive: Int, group: String, file: Int, buf: ByteBuf, key: SymmetricKey = SymmetricKey.ZERO)

@JvmOverloads

fun write(archive: Int, group: String, file: String, buf: ByteBuf, key: SymmetricKey = SymmetricKey.ZERO)

writeNamed

@JvmOverloads

fun writeNamed(archive: Int, groupNameHash: Int, fileNameHash: Int, buf: ByteBuf, key: SymmetricKey = SymmetricKey.ZERO)

writeNamedGroup

@JvmOverloads

fun writeNamedGroup(archive: Int, groupNameHash: Int, file: Int, buf: ByteBuf, key: SymmetricKey = SymmetricKey.ZERO)