avail/avail.files/AbstractAvailTextFile

AbstractAvailTextFile

abstract class AbstractAvailTextFile(val charset: Charset, val fileWrapper: AbstractFileWrapper) : AvailFile

A AbstractAvailTextFile is an abstract AvailFile that is has text in a provided Charset.

Author

Richard Arriaga

Parameters

charset

The Charset of the file.

fileWrapper

The AbstractFileWrapper that wraps this AvailFile.

Constructors

AbstractAvailTextFile

constructor(charset: Charset, fileWrapper: AbstractFileWrapper)

Construct an AvailFile.

Properties

val charset: Charset

The Charset of the file.

val fileWrapper: AbstractFileWrapper

The AbstractFileWrapper that wraps this AvailFile.

val isOpen: Boolean

true indicates the file is open; false indicates it is closed.

var lastEdit: Long

Time in milliseconds since the unix epoch UTC when this file was lasted edited.

var lastModified: Long

The last time in milliseconds since the Unix epoch that the file was updated.

val mimeType: String

The mime type of this file.

abstract val rawContent: ByteArray

The raw bytes of the file.

Functions

conditionallyClearDirty

fun conditionallyClearDirty(saveTimeStart: Long)

Indicate this file has been edited to be different than what is saved to disk.

abstract fun editRange(data: ByteArray, start: Int, end: Int, timestamp: Long = System.currentTimeMillis(), originator: UUID): TracedAction

Insert the ByteArray data into the file at the specified location. This should remove existing data in the file in this range and replace it with the provided data. This should preserve all data outside of this range.

getSavableContent

open fun getSavableContent(): ByteArray

fun markDirty()

Indicate this file has been edited to be different than what is saved to disk.

abstract fun replaceFile(data: ByteArray, timestamp: Long = System.currentTimeMillis(), originator: UUID): TracedAction

Replace the entire contents of the file with the provided byte array.