graalvm/tools.elide.vfs/File/Builder

Builder

class Builder : GeneratedMessage.Builder<BuilderT> , FileOrBuilder

# VFS: File

Describes a single `File`-type entry within a given `TreeEntry`, within a virtual file system managed by Elide. File
entries describe file metadata only; raw file data is enclosed in a compressed blob stored alongside filesystem
metadata.

See individual properties for more information. `File` objects can only be held by `TreeEntry` objects. `Directory`
objects refer to their child `TreeEntry` constituents.

Protobuf type elide.vfs.File

Properties

fingerprintOrNull

val FileOrBuilder.fingerprintOrNull: File.FileFingerprint?

modifiedOrNull

val FileOrBuilder.modifiedOrNull: Timestamp?

Functions

addRepeatedField

open fun addRepeatedField(field: Descriptors.FieldDescriptor, value: Any): BuilderT

abstract fun addRepeatedField(field: Descriptors.FieldDescriptor, value: Any): Message.Builder

build

abstract fun build(): MessageLite

open fun build(): File

buildPartial

abstract fun buildPartial(): MessageLite

open fun buildPartial(): File

clear

open fun clear(): BuilderType

abstract fun clear(): Message.Builder

open fun clear(): File.Builder

clearAttributes

open fun clearAttributes(): File.Builder

clearCompressed

open fun clearCompressed(): File.Builder

Compressed size of the file, in bytes. If `size` and `compressed` are equal, the file is not compressed.

uint64 compressed = 3;

clearEncoding

open fun clearEncoding(): File.Builder

Describes the encoding of the file.

.elide.data.Encoding encoding = 6;

clearField

open fun clearField(field: Descriptors.FieldDescriptor): BuilderT

abstract fun clearField(field: Descriptors.FieldDescriptor): Message.Builder

clearFileType

open fun clearFileType(): File.Builder

clearFingerprint

open fun clearFingerprint(): File.Builder

Fingerprints of compressed and regular file representations, as applicable.

.elide.vfs.File.FileFingerprint fingerprint = 10;

clearKnown

open fun clearKnown(): File.Builder

Specifies a known MIME type for this file, from the [KnownMimeType] enumeration.

.elide.vfs.KnownMimeType known = 8;

clearMime

open fun clearMime(): File.Builder

Specifies a string for a mime-type. This is only used if the mime-type is not known to the VM implementation.

string mime = 9;

clearModified

open fun clearModified(): File.Builder

Describes the last time this file was modified. This value is only available in circumstances where the VFS is
running with change tracking enabled (namely, during development). In production, this value will be set to a
consistent timestamp for all assets.

.google.protobuf.Timestamp modified = 7;

clearName

open fun clearName(): File.Builder

Name of the file.

string name = 1;

clearOffset

open fun clearOffset(): File.Builder

Offset at which the file begins within the compressed filesystem blob.

uint64 offset = 4;

clearOneof

open fun clearOneof(oneof: Descriptors.OneofDescriptor): BuilderType

open fun clearOneof(oneof: Descriptors.OneofDescriptor): BuilderT

abstract fun clearOneof(oneof: Descriptors.OneofDescriptor): Message.Builder

clearSize

open fun clearSize(): File.Builder

Uncompressed size of the file, in bytes.

uint64 size = 2;

clearTail

open fun clearTail(): File.Builder

Offset at which the file ends within the compressed filesystem blob.

uint64 tail = 5;

clone

open fun clone(): BuilderType

open fun clone(): BuilderT

abstract fun clone(): Message.Builder

containsAttributes

open fun containsAttributes(key: String): Boolean

Extended attributes for this file.

map<string, string> attributes = 11;

findInitializationErrors

open fun findInitializationErrors(): List<String>

getAllFields

open fun getAllFields(): Map<Descriptors.FieldDescriptor, Any>

getAttributes

open fun ~~getAttributes~~(): Map<String, String>

Use getAttributesMap instead.

getAttributesCount

open fun getAttributesCount(): Int

Extended attributes for this file.

map<string, string> attributes = 11;

getAttributesMap

open fun getAttributesMap(): Map<String, String>

Extended attributes for this file.

map<string, string> attributes = 11;

getAttributesOrDefault

open fun getAttributesOrDefault(key: String, defaultValue: String): String

Extended attributes for this file.

map<string, string> attributes = 11;

getAttributesOrThrow

open fun getAttributesOrThrow(key: String): String

Extended attributes for this file.

map<string, string> attributes = 11;

getCompressed

open fun getCompressed(): Long

Compressed size of the file, in bytes. If `size` and `compressed` are equal, the file is not compressed.

uint64 compressed = 3;

getDefaultInstanceForType

abstract fun getDefaultInstanceForType(): MessageLite

open fun getDefaultInstanceForType(): File

getDescriptor

fun getDescriptor(): Descriptors.Descriptor

getDescriptorForType

open fun getDescriptorForType(): Descriptors.Descriptor

getEncoding

open fun getEncoding(): Encoding

Describes the encoding of the file.

.elide.data.Encoding encoding = 6;

getEncodingValue

open fun getEncodingValue(): Int

Describes the encoding of the file.

.elide.data.Encoding encoding = 6;

getField

open fun getField(field: Descriptors.FieldDescriptor): Any

getFieldBuilder

open fun getFieldBuilder(field: Descriptors.FieldDescriptor): Message.Builder

getFileTypeCase

open fun getFileTypeCase(): File.FileTypeCase

getFingerprint

open fun getFingerprint(): File.FileFingerprint

Fingerprints of compressed and regular file representations, as applicable.

.elide.vfs.File.FileFingerprint fingerprint = 10;

getFingerprintBuilder

open fun getFingerprintBuilder(): File.FileFingerprint.Builder

Fingerprints of compressed and regular file representations, as applicable.

.elide.vfs.File.FileFingerprint fingerprint = 10;

getFingerprintOrBuilder

open fun getFingerprintOrBuilder(): File.FileFingerprintOrBuilder

Fingerprints of compressed and regular file representations, as applicable.

.elide.vfs.File.FileFingerprint fingerprint = 10;

getInitializationErrorString

open fun getInitializationErrorString(): String

getKnown

open fun getKnown(): KnownMimeType

Specifies a known MIME type for this file, from the [KnownMimeType] enumeration.

.elide.vfs.KnownMimeType known = 8;

getKnownValue

open fun getKnownValue(): Int

Specifies a known MIME type for this file, from the [KnownMimeType] enumeration.

.elide.vfs.KnownMimeType known = 8;

getMime

open fun getMime(): String

Specifies a string for a mime-type. This is only used if the mime-type is not known to the VM implementation.

string mime = 9;

getMimeBytes

open fun getMimeBytes(): ByteString

Specifies a string for a mime-type. This is only used if the mime-type is not known to the VM implementation.

string mime = 9;

getModified

open fun getModified(): Timestamp

Describes the last time this file was modified. This value is only available in circumstances where the VFS is
running with change tracking enabled (namely, during development). In production, this value will be set to a
consistent timestamp for all assets.

.google.protobuf.Timestamp modified = 7;

getModifiedBuilder

open fun getModifiedBuilder(): Timestamp.Builder

Describes the last time this file was modified. This value is only available in circumstances where the VFS is
running with change tracking enabled (namely, during development). In production, this value will be set to a
consistent timestamp for all assets.

.google.protobuf.Timestamp modified = 7;

getModifiedOrBuilder

open fun getModifiedOrBuilder(): TimestampOrBuilder

Describes the last time this file was modified. This value is only available in circumstances where the VFS is
running with change tracking enabled (namely, during development). In production, this value will be set to a
consistent timestamp for all assets.

.google.protobuf.Timestamp modified = 7;

getMutableAttributes

open fun ~~getMutableAttributes~~(): Map<String, String>

Use alternate mutation accessors instead.

getName

open fun getName(): String

Name of the file.

string name = 1;

getNameBytes

open fun getNameBytes(): ByteString

Name of the file.

string name = 1;

getOffset

open fun getOffset(): Long

Offset at which the file begins within the compressed filesystem blob.

uint64 offset = 4;

getOneofFieldDescriptor

open fun getOneofFieldDescriptor(oneof: Descriptors.OneofDescriptor): Descriptors.FieldDescriptor

getRepeatedField

open fun getRepeatedField(field: Descriptors.FieldDescriptor, index: Int): Any

getRepeatedFieldBuilder

open fun getRepeatedFieldBuilder(field: Descriptors.FieldDescriptor, index: Int): Message.Builder

getRepeatedFieldCount

open fun getRepeatedFieldCount(field: Descriptors.FieldDescriptor): Int

getSize

open fun getSize(): Long

Uncompressed size of the file, in bytes.

uint64 size = 2;

getTail

open fun getTail(): Long

Offset at which the file ends within the compressed filesystem blob.

uint64 tail = 5;

getUnknownFields

fun getUnknownFields(): UnknownFieldSet

hasField

open fun hasField(field: Descriptors.FieldDescriptor): Boolean

hasFingerprint

open fun hasFingerprint(): Boolean

Fingerprints of compressed and regular file representations, as applicable.

.elide.vfs.File.FileFingerprint fingerprint = 10;

hasKnown

open fun hasKnown(): Boolean

Specifies a known MIME type for this file, from the [KnownMimeType] enumeration.

.elide.vfs.KnownMimeType known = 8;

hasMime

open fun hasMime(): Boolean

Specifies a string for a mime-type. This is only used if the mime-type is not known to the VM implementation.

string mime = 9;

hasModified

open fun hasModified(): Boolean

Describes the last time this file was modified. This value is only available in circumstances where the VFS is
running with change tracking enabled (namely, during development). In production, this value will be set to a
consistent timestamp for all assets.

.google.protobuf.Timestamp modified = 7;

hasOneof

open fun hasOneof(oneof: Descriptors.OneofDescriptor): Boolean

isInitialized

fun isInitialized(): Boolean

mergeDelimitedFrom

open fun mergeDelimitedFrom(input: InputStream, extensionRegistry: ExtensionRegistryLite): Boolean

mergeFingerprint

open fun mergeFingerprint(value: File.FileFingerprint): File.Builder

Fingerprints of compressed and regular file representations, as applicable.

.elide.vfs.File.FileFingerprint fingerprint = 10;

mergeFrom

abstract fun mergeFrom(other: Message): Message.Builder

open fun mergeFrom(other: Message): File.Builder

open fun mergeFrom(other: File): File.Builder

open fun mergeFrom(input: CodedInputStream, extensionRegistry: ExtensionRegistryLite): File.Builder

mergeModified

open fun mergeModified(value: Timestamp): File.Builder

Describes the last time this file was modified. This value is only available in circumstances where the VFS is
running with change tracking enabled (namely, during development). In production, this value will be set to a
consistent timestamp for all assets.

.google.protobuf.Timestamp modified = 7;

mergeUnknownFields

open fun mergeUnknownFields(unknownFields: UnknownFieldSet): BuilderType

open fun mergeUnknownFields(unknownFields: UnknownFieldSet): BuilderT

abstract fun mergeUnknownFields(unknownFields: UnknownFieldSet): Message.Builder

newBuilderForField

open fun newBuilderForField(field: Descriptors.FieldDescriptor): Message.Builder

putAllAttributes

open fun putAllAttributes(values: Map<String, String>): File.Builder

Extended attributes for this file.

map<string, string> attributes = 11;

putAttributes

open fun putAttributes(key: String, value: String): File.Builder

Extended attributes for this file.

map<string, string> attributes = 11;

removeAttributes

open fun removeAttributes(key: String): File.Builder

Extended attributes for this file.

map<string, string> attributes = 11;

setCompressed

open fun setCompressed(value: Long): File.Builder

Compressed size of the file, in bytes. If `size` and `compressed` are equal, the file is not compressed.

uint64 compressed = 3;

setEncoding

open fun setEncoding(value: Encoding): File.Builder

Describes the encoding of the file.

.elide.data.Encoding encoding = 6;

setEncodingValue

open fun setEncodingValue(value: Int): File.Builder

Describes the encoding of the file.

.elide.data.Encoding encoding = 6;

setField

open fun setField(field: Descriptors.FieldDescriptor, value: Any): BuilderT

abstract fun setField(field: Descriptors.FieldDescriptor, value: Any): Message.Builder

setFingerprint

open fun setFingerprint(value: File.FileFingerprint): File.Builder

open fun setFingerprint(builderForValue: File.FileFingerprint.Builder): File.Builder

Fingerprints of compressed and regular file representations, as applicable.

.elide.vfs.File.FileFingerprint fingerprint = 10;

setKnown

open fun setKnown(value: KnownMimeType): File.Builder

Specifies a known MIME type for this file, from the [KnownMimeType] enumeration.

.elide.vfs.KnownMimeType known = 8;

setKnownValue

open fun setKnownValue(value: Int): File.Builder

Specifies a known MIME type for this file, from the [KnownMimeType] enumeration.

.elide.vfs.KnownMimeType known = 8;

setMime

open fun setMime(value: String): File.Builder

Specifies a string for a mime-type. This is only used if the mime-type is not known to the VM implementation.

string mime = 9;

setMimeBytes

open fun setMimeBytes(value: ByteString): File.Builder

Specifies a string for a mime-type. This is only used if the mime-type is not known to the VM implementation.

string mime = 9;

setModified

open fun setModified(value: Timestamp): File.Builder

open fun setModified(builderForValue: Timestamp.Builder): File.Builder

Describes the last time this file was modified. This value is only available in circumstances where the VFS is
running with change tracking enabled (namely, during development). In production, this value will be set to a
consistent timestamp for all assets.

.google.protobuf.Timestamp modified = 7;

setName

open fun setName(value: String): File.Builder

Name of the file.

string name = 1;

setNameBytes

open fun setNameBytes(value: ByteString): File.Builder

Name of the file.

string name = 1;

setOffset

open fun setOffset(value: Long): File.Builder

Offset at which the file begins within the compressed filesystem blob.

uint64 offset = 4;

setRepeatedField

open fun setRepeatedField(field: Descriptors.FieldDescriptor, index: Int, value: Any): BuilderT

abstract fun setRepeatedField(field: Descriptors.FieldDescriptor, index: Int, value: Any): Message.Builder

setSize

open fun setSize(value: Long): File.Builder

Uncompressed size of the file, in bytes.

uint64 size = 2;

setTail

open fun setTail(value: Long): File.Builder

Offset at which the file ends within the compressed filesystem blob.

uint64 tail = 5;

setUnknownFields

open fun setUnknownFields(unknownFields: UnknownFieldSet): BuilderT

abstract fun setUnknownFields(unknownFields: UnknownFieldSet): Message.Builder

toString

open fun toString(): String