avail/avail.files/NullFileWrapper

NullFileWrapper

class NullFileWrapper(raw: ByteArray, resolverReference: ResolverReference, fileManager: FileManager) : AbstractFileWrapper

A NullFileWrapper is an AbstractFileWrapper not used by the FileManager to hold an AvailFile that is on the file system of the machine Avail is running. The purpose of this is to enable access outside of the FileManager.

Author

Richard Arriaga

Parameters

resolverReference

The reference of the target file.

fileManager

The FileManager this ManagedFileWrapper belongs to.

Constructors

NullFileWrapper

constructor(raw: ByteArray, resolverReference: ResolverReference, fileManager: FileManager)

Construct a NullFileWrapper.

Types

Companion

object Companion

Properties

error

open val error: Throwable? = null

The Throwable if one was encountered when opening the file, null otherwise.

errorCode

open val errorCode: ErrorCode? = null

The associated ErrorCode if error is not null; null otherwise

file

open override val file: AvailFile

The AvailFile wrapped by this NullFileWrapper.

val id: UUID

The FileManager.fileCache key.

interestCount

val interestCount: AtomicInteger

The number of clients that actively have this file open.

isClosed

val isClosed: Boolean

Is the file closed? true indicates it is; false otherwise.

isError

open val isError: Boolean

true indicates that there was an error; false otherwise.

reference

val reference: ResolverReference

The ResolverReference of the target file on disk.

Functions

fun close()

Close this ManagedFileWrapper.

conditionallySaveToLocalHistory

fun conditionallySaveToLocalHistory()

Save the tracedActionStack to local history starting from the position at tracedActionStackSavePointer.

delete

open override fun delete(success: (UUID?) -> Unit, failure: (ErrorCode, Throwable?) -> Unit)

Delete the wrapped file from its storage location.

execute

@Synchronized

fun execute(fileAction: FileAction, originator: UUID, continuation: () -> Unit)

Update the wrapped AvailFile with the provided FileAction.

notifyOpenFailure

fun notifyOpenFailure(errorCode: ErrorCode, e: Throwable? = null)

Notify the FileRequestHandlers in ManagedFileWrapper.fileRequestQueue that the file action encountered a failure while opening.

notifyReady

fun notifyReady()

Notify this ManagedFileWrapper that the AvailFile has been fully read.

provide

fun provide(registerInterest: Boolean, successHandler: (UUID, String, AvailFile) -> Unit, failureHandler: (ErrorCode, Throwable?) -> Unit)

Provide the raw bytes of the enclosed AvailFile to the requesting consumer.

redo

fun redo(originator: UUID)

If an undo resulted in a revert on the file and no other FileAction has occurred since, redo the previously reverted action.

undo

fun undo(originator: UUID)

Undo the FileAction performed on the file from the TracedAction that is undoStackDepth + 1 from the top of the stack.