graalvm/tools.elide.struct/BloomFilter/Builder

Builder

class Builder : GeneratedMessage.Builder<BuilderT> , BloomFilterOrBuilder

Defines a structure that is operable as a 1-to-n-layer Bloom filter. NIST (the National Institute of Standards and
Technology) defines a *"Bloom filter"* as a "data structure with a probabilistic algorithm to quickly test membership
in a large set using multiple hash functions into a single array of bits."

In essence, a Bloom filter is a very compact set of data, which operates kind of like a cheese cloth. For each unique
data fingerprint applied to the filter, you can imagine throwing colored die at the cheese cloth - what you end up
with is some blend of colors, which is entirely unique and ephemeral, having been constituted entirely by the colors
you chose, and the exact parameters of how you threw them. Albeit a contrived example, one could then imagine simply
examining the result of your work to determine the presence of different colors.

Bloom filters work the same way. Since their invention in by Burton Howard Bloom in 1970, many exotic forms of Bloom
filters have shown up, a few of which this structure supports. For example, one may choose to enhance regular filters
with the count of items considered in the filter, making it a *Counting Bloom filter*. Or, one may choose to combine
multiple filters into one effective filter, which is referred to as a *Layered Bloom filter*.

Protobuf type elide.structs.BloomFilter

Functions

addAllLayer

open fun addAllLayer(values: Iterable<out BloomFilter.FilterLayer>): BloomFilter.Builder

Specifies each layer of this Bloom filter structure. If no more than one layer is present, the structure represents
a simple, single-layer regular Bloom filter. If more than one layer are present, the structure represents a multi-
layer (*Layered*) Bloom filter.

repeated .elide.structs.BloomFilter.FilterLayer layer = 5;

addLayer

open fun addLayer(value: BloomFilter.FilterLayer): BloomFilter.Builder

open fun addLayer(builderForValue: BloomFilter.FilterLayer.Builder): BloomFilter.Builder

open fun addLayer(index: Int, value: BloomFilter.FilterLayer): BloomFilter.Builder

open fun addLayer(index: Int, builderForValue: BloomFilter.FilterLayer.Builder): BloomFilter.Builder

Specifies each layer of this Bloom filter structure. If no more than one layer is present, the structure represents
a simple, single-layer regular Bloom filter. If more than one layer are present, the structure represents a multi-
layer (*Layered*) Bloom filter.

repeated .elide.structs.BloomFilter.FilterLayer layer = 5;

addLayerBuilder

open fun addLayerBuilder(): BloomFilter.FilterLayer.Builder

open fun addLayerBuilder(index: Int): BloomFilter.FilterLayer.Builder

Specifies each layer of this Bloom filter structure. If no more than one layer is present, the structure represents
a simple, single-layer regular Bloom filter. If more than one layer are present, the structure represents a multi-
layer (*Layered*) Bloom filter.

repeated .elide.structs.BloomFilter.FilterLayer layer = 5;

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(): BloomFilter

buildPartial

abstract fun buildPartial(): MessageLite

open fun buildPartial(): BloomFilter

clear

open fun clear(): BuilderType

abstract fun clear(): Message.Builder

open fun clear(): BloomFilter.Builder

clearAlgorithm

open fun clearAlgorithm(): BloomFilter.Builder

Hash algorithm in use for this Bloom filter. This must be considered an immutable value for a constituted filter,
otherwise the underlying data may be rendered unusable.

.elide.std.HashAlgorithm algorithm = 1;

clearCount

open fun clearCount(): BloomFilter.Builder

Number of items in the filter, across all layers.

uint64 count = 3;

clearField

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

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

clearLayer

open fun clearLayer(): BloomFilter.Builder

Specifies each layer of this Bloom filter structure. If no more than one layer is present, the structure represents
a simple, single-layer regular Bloom filter. If more than one layer are present, the structure represents a multi-
layer (*Layered*) Bloom filter.

repeated .elide.structs.BloomFilter.FilterLayer layer = 5;

clearLimit

open fun clearLimit(): BloomFilter.Builder

Limit setting to enforce for this Bloom filter, before re-calculating contents. Optional.

uint64 limit = 4;

clearOneof

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

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

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

clearRounds

open fun clearRounds(): BloomFilter.Builder

Number of hash rounds to apply when adding data to this filter.

uint32 rounds = 2;

clone

open fun clone(): BuilderType

open fun clone(): BuilderT

abstract fun clone(): Message.Builder

findInitializationErrors

open fun findInitializationErrors(): List<String>

getAlgorithm

open fun getAlgorithm(): HashAlgorithm

Hash algorithm in use for this Bloom filter. This must be considered an immutable value for a constituted filter,
otherwise the underlying data may be rendered unusable.

.elide.std.HashAlgorithm algorithm = 1;

getAlgorithmValue

open fun getAlgorithmValue(): Int

Hash algorithm in use for this Bloom filter. This must be considered an immutable value for a constituted filter,
otherwise the underlying data may be rendered unusable.

.elide.std.HashAlgorithm algorithm = 1;

getAllFields

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

getCount

open fun getCount(): Long

Number of items in the filter, across all layers.

uint64 count = 3;

getDefaultInstanceForType

abstract fun getDefaultInstanceForType(): MessageLite

open fun getDefaultInstanceForType(): BloomFilter

getDescriptor

fun getDescriptor(): Descriptors.Descriptor

getDescriptorForType

open fun getDescriptorForType(): Descriptors.Descriptor

getField

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

getFieldBuilder

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

getInitializationErrorString

open fun getInitializationErrorString(): String

getLayer

open fun getLayer(index: Int): BloomFilter.FilterLayer

Specifies each layer of this Bloom filter structure. If no more than one layer is present, the structure represents
a simple, single-layer regular Bloom filter. If more than one layer are present, the structure represents a multi-
layer (*Layered*) Bloom filter.

repeated .elide.structs.BloomFilter.FilterLayer layer = 5;

getLayerBuilder

open fun getLayerBuilder(index: Int): BloomFilter.FilterLayer.Builder

Specifies each layer of this Bloom filter structure. If no more than one layer is present, the structure represents
a simple, single-layer regular Bloom filter. If more than one layer are present, the structure represents a multi-
layer (*Layered*) Bloom filter.

repeated .elide.structs.BloomFilter.FilterLayer layer = 5;

getLayerBuilderList

open fun getLayerBuilderList(): List<BloomFilter.FilterLayer.Builder>

Specifies each layer of this Bloom filter structure. If no more than one layer is present, the structure represents
a simple, single-layer regular Bloom filter. If more than one layer are present, the structure represents a multi-
layer (*Layered*) Bloom filter.

repeated .elide.structs.BloomFilter.FilterLayer layer = 5;

getLayerCount

open fun getLayerCount(): Int

Specifies each layer of this Bloom filter structure. If no more than one layer is present, the structure represents
a simple, single-layer regular Bloom filter. If more than one layer are present, the structure represents a multi-
layer (*Layered*) Bloom filter.

repeated .elide.structs.BloomFilter.FilterLayer layer = 5;

getLayerList

open fun getLayerList(): List<BloomFilter.FilterLayer>

Specifies each layer of this Bloom filter structure. If no more than one layer is present, the structure represents
a simple, single-layer regular Bloom filter. If more than one layer are present, the structure represents a multi-
layer (*Layered*) Bloom filter.

repeated .elide.structs.BloomFilter.FilterLayer layer = 5;

getLayerOrBuilder

open fun getLayerOrBuilder(index: Int): BloomFilter.FilterLayerOrBuilder

Specifies each layer of this Bloom filter structure. If no more than one layer is present, the structure represents
a simple, single-layer regular Bloom filter. If more than one layer are present, the structure represents a multi-
layer (*Layered*) Bloom filter.

repeated .elide.structs.BloomFilter.FilterLayer layer = 5;

getLayerOrBuilderList

open fun getLayerOrBuilderList(): List<out BloomFilter.FilterLayerOrBuilder>

Specifies each layer of this Bloom filter structure. If no more than one layer is present, the structure represents
a simple, single-layer regular Bloom filter. If more than one layer are present, the structure represents a multi-
layer (*Layered*) Bloom filter.

repeated .elide.structs.BloomFilter.FilterLayer layer = 5;

getLimit

open fun getLimit(): Long

Limit setting to enforce for this Bloom filter, before re-calculating contents. Optional.

uint64 limit = 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

getRounds

open fun getRounds(): Int

Number of hash rounds to apply when adding data to this filter.

uint32 rounds = 2;

getUnknownFields

fun getUnknownFields(): UnknownFieldSet

hasField

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

hasOneof

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

isInitialized

fun isInitialized(): Boolean

mergeDelimitedFrom

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

mergeFrom

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

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

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

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

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

removeLayer

open fun removeLayer(index: Int): BloomFilter.Builder

Specifies each layer of this Bloom filter structure. If no more than one layer is present, the structure represents
a simple, single-layer regular Bloom filter. If more than one layer are present, the structure represents a multi-
layer (*Layered*) Bloom filter.

repeated .elide.structs.BloomFilter.FilterLayer layer = 5;

setAlgorithm

open fun setAlgorithm(value: HashAlgorithm): BloomFilter.Builder

Hash algorithm in use for this Bloom filter. This must be considered an immutable value for a constituted filter,
otherwise the underlying data may be rendered unusable.

.elide.std.HashAlgorithm algorithm = 1;

setAlgorithmValue

open fun setAlgorithmValue(value: Int): BloomFilter.Builder

Hash algorithm in use for this Bloom filter. This must be considered an immutable value for a constituted filter,
otherwise the underlying data may be rendered unusable.

.elide.std.HashAlgorithm algorithm = 1;

setCount

open fun setCount(value: Long): BloomFilter.Builder

Number of items in the filter, across all layers.

uint64 count = 3;

setField

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

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

setLayer

open fun setLayer(index: Int, value: BloomFilter.FilterLayer): BloomFilter.Builder

open fun setLayer(index: Int, builderForValue: BloomFilter.FilterLayer.Builder): BloomFilter.Builder

Specifies each layer of this Bloom filter structure. If no more than one layer is present, the structure represents
a simple, single-layer regular Bloom filter. If more than one layer are present, the structure represents a multi-
layer (*Layered*) Bloom filter.

repeated .elide.structs.BloomFilter.FilterLayer layer = 5;

setLimit

open fun setLimit(value: Long): BloomFilter.Builder

Limit setting to enforce for this Bloom filter, before re-calculating contents. Optional.

uint64 limit = 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

setRounds

open fun setRounds(value: Int): BloomFilter.Builder

Number of hash rounds to apply when adding data to this filter.

uint32 rounds = 2;

setUnknownFields

open fun setUnknownFields(unknownFields: UnknownFieldSet): BuilderT

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

toString

open fun toString(): String