model-api/org.modelix.model.api/IBranch

IBranch

interface IBranch

Representation of a branch.

Inheritors

IBranchWrapper

PBranch

TreePointer

Properties

readTransaction

abstract val readTransaction: IReadTransaction

Read transaction for this branch.

transaction

abstract val transaction: ITransaction

Transaction for this branch.

writeTransaction

abstract val writeTransaction: IWriteTransaction

Write transaction for this branch.

Functions

addListener

abstract fun addListener(l: IBranchListener)

Adds the given branch listener to this branch.

canRead

abstract fun canRead(): Boolean

Checks if read operations can be performed on this branch.

canWrite

abstract fun canWrite(): Boolean

Checks if write operations can be performed on this branch.

computeRead

abstract fun <T> computeRead(computable: () -> T): T

Performs a computable read operation, which returns a value, on this branch.

computeReadT

open fun <T> computeReadT(computable: (IReadTransaction) -> T): T

Performs a computable read operation, which returns a value, in a read transaction on this branch.

computeWrite

abstract fun <T> computeWrite(computable: () -> T): T

Performs a computable write operation, which returns a value, on this branch.

computeWriteT

open fun <T> computeWriteT(computable: (IWriteTransaction) -> T): T

Performs a computable write operation, which returns a value, in a write transaction on this branch.

deepUnwrap

fun IBranch.deepUnwrap(): IBranch

Recursively unwraps a branch.

getArea

fun IBranch.getArea(): PArea

getId

abstract fun getId(): String

Returns the id of this branch.

getNode

fun IBranch.getNode(id: Long): INode

getRootNode

fun IBranch.getRootNode(): INode

removeListener

abstract fun removeListener(l: IBranchListener)

Removes the given branch listener from this branch.

runRead

abstract fun runRead(runnable: () -> Unit)

Performs a read operation on this branch.

runReadT

open fun runReadT(f: (IReadTransaction) -> Unit)

Performs a function in a read transaction on this branch.

runWrite

abstract fun runWrite(runnable: () -> Unit)

Performs a write operation on this branch.

runWriteT

open fun runWriteT(f: (IWriteTransaction) -> Unit)

Performs a function in a write transaction on this branch.