Index (DeletionChecker API)

B C D E F G H I L M O P R S T U W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

B

bucketCount() - Method in class com.marksayson.deletionchecker.format.PrefixIndex: Returns the number of buckets, always at least 1.
bucketEnd(int) - Method in class com.marksayson.deletionchecker.format.PrefixIndex: Returns the entry index just past the last entry of the given bucket.
bucketStart(int) - Method in class com.marksayson.deletionchecker.format.PrefixIndex: Returns the first entry index of the given bucket.
build(List<byte[]>) - Static method in class com.marksayson.deletionchecker.format.PrefixIndex: Builds an index over sortedIdentifiers using PrefixIndex.DEFAULT_BUCKET_SIZE.
build(List<byte[]>, int) - Static method in class com.marksayson.deletionchecker.format.PrefixIndex: Builds an index over sortedIdentifiers with the given bucket target size.

C

canonicalize(DatasetManifest) - Static method in class com.marksayson.deletionchecker.manifest.ManifestCanonicalizer: Returns the canonical JSON for manifest, without a manifestChecksum field.
checksum() - Method in class com.marksayson.deletionchecker.format.PackedDeletionSet: Returns this file's CRC32C, as read from its header and already verified against the file's actual bytes by PackedDeletionSet.open(java.nio.file.Path, java.lang.String), as an unsigned 32-bit value in the low bits of the result.
checksum() - Method in record class com.marksayson.deletionchecker.manifest.EntityTypeEntry: Returns the value of the checksum record component.
checksum(String) - Static method in class com.marksayson.deletionchecker.manifest.ManifestCanonicalizer: Returns the manifestChecksum value for the manifest whose checksum-free canonical form is canonicalJson: ManifestCanonicalizer.CHECKSUM_PREFIX followed by the lowercase-hex SHA-256 of that form's UTF-8 bytes.
CHECKSUM_PREFIX - Static variable in class com.marksayson.deletionchecker.manifest.ManifestCanonicalizer: Algorithm prefix on a manifestChecksum value: "sha256:".
Checksums - Class in com.marksayson.deletionchecker.checksum: Checksum helpers that operate over a region of a buffer without copying it.
com.marksayson.deletionchecker - package com.marksayson.deletionchecker: The public API: DeletionChecker, loaded once at startup from a packed dataset (com.marksayson.deletionchecker.format) and its manifest (com.marksayson.deletionchecker.manifest), then queried with isDeleted and filter for the lifetime of the instance.
com.marksayson.deletionchecker.checksum - package com.marksayson.deletionchecker.checksum: CRC32C and SHA-256 helpers that hash a region of a buffer in place, without copying it.
com.marksayson.deletionchecker.format - package com.marksayson.deletionchecker.format: The packed binary file format: one immutable, checksummed file per entity type, both read and written here.
com.marksayson.deletionchecker.manifest - package com.marksayson.deletionchecker.manifest: The dataset manifest: a small JSON document, separate from the packed entity-type files, that records a release's format/generator/dataset versions and lists its available entity types.
contains(byte[]) - Method in class com.marksayson.deletionchecker.format.PackedDeletionSet: Returns whether id is recorded as deleted for this entity type.
CorruptDatasetException - Exception Class in com.marksayson.deletionchecker.format: Thrown when a dataset file is structurally invalid or fails its integrity check — bad magic bytes, a checksum mismatch, an entity-type mismatch, or an out-of-range header field.
CorruptDatasetException(String) - Constructor for exception class com.marksayson.deletionchecker.format.CorruptDatasetException: Creates the exception.
Crc32c - Class in com.marksayson.deletionchecker.checksum: CRC32C (Castagnoli, 32-bit) — the integrity check on each packed entity-type file.
crc32cReference(long) - Static method in record class com.marksayson.deletionchecker.manifest.EntityTypeEntry: Renders a CRC32C value as a manifest checksum reference: "crc32c:" followed by the value's low 32 bits as 8 lowercase hex digits.
crc32cWithFieldZeroed(ByteBuffer, int, int) - Static method in class com.marksayson.deletionchecker.checksum.Checksums: Computes the CRC32C of file's bytes from index 0 to its limit, as if the fieldLength bytes starting at fieldOffset were zero.

D

DatasetManifest - Record Class in com.marksayson.deletionchecker.manifest: A parsed, verified dataset manifest: the release's three version fields plus one entry per available entity type.
DatasetManifest(int, String, String, List<EntityTypeEntry>) - Constructor for record class com.marksayson.deletionchecker.manifest.DatasetManifest: Makes the entity-type list immutable.
datasetVersion() - Method in class com.marksayson.deletionchecker.DeletionChecker: Returns the loaded release's datasetVersion — the ISO-8601 timestamp identifying which generation run's deletion data this instance holds.
datasetVersion() - Method in record class com.marksayson.deletionchecker.manifest.DatasetManifest: Returns the value of the datasetVersion record component.
DEFAULT_BLOOM_FPR - Static variable in class com.marksayson.deletionchecker.format.PackedFileWriter: Default Bloom-filter false-positive rate — see PackedFileWriter.write(String, List, int, double).
DEFAULT_BUCKET_SIZE - Static variable in class com.marksayson.deletionchecker.format.PrefixIndex: The generator's launch default for the bucket target size K.
DeletionChecker - Class in com.marksayson.deletionchecker: Local, exact deletion-state lookup over a packed, immutable binary dataset.

E

encode(String) - Static method in class com.marksayson.deletionchecker.IdentifierCodec: Validates identifier and returns its UTF-8 encoding.
entityType() - Method in class com.marksayson.deletionchecker.format.PackedDeletionSet: Returns the entity type this file holds, as read from its header.
entityType() - Method in record class com.marksayson.deletionchecker.manifest.EntityTypeEntry: Returns the value of the entityType record component.
EntityTypeEntry - Record Class in com.marksayson.deletionchecker.manifest: One entity type's entry in the dataset manifest.
EntityTypeEntry(String, String, long, String) - Constructor for record class com.marksayson.deletionchecker.manifest.EntityTypeEntry: Validates the entry.
entityTypes() - Method in record class com.marksayson.deletionchecker.manifest.DatasetManifest: Returns the value of the entityTypes record component.
entry(String) - Method in record class com.marksayson.deletionchecker.manifest.DatasetManifest: Returns the entry for entityType, if the release contains it.
equals(Object) - Method in record class com.marksayson.deletionchecker.manifest.DatasetManifest: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.marksayson.deletionchecker.manifest.EntityTypeEntry: Indicates whether some other object is "equal to" this one.

F

FILE_NAME - Static variable in record class com.marksayson.deletionchecker.manifest.DatasetManifest: The manifest file's name within a dataset directory.
fileName() - Method in record class com.marksayson.deletionchecker.manifest.EntityTypeEntry: Returns the value of the fileName record component.
filter(String, List<T>, Function<T, String>) - Method in class com.marksayson.deletionchecker.DeletionChecker: Returns the items whose extracted identifier is not recorded as deleted for entityType, in their original order.
formatVersion() - Method in record class com.marksayson.deletionchecker.manifest.DatasetManifest: Returns the value of the formatVersion record component.
found() - Method in exception class com.marksayson.deletionchecker.format.UnsupportedFormatVersionException: Returns the format version read from the file.
found() - Method in exception class com.marksayson.deletionchecker.manifest.UnsupportedManifestVersionException: Returns the formatVersion read from the manifest.

G

generatorVersion() - Method in record class com.marksayson.deletionchecker.manifest.DatasetManifest: Returns the value of the generatorVersion record component.

H

hashCode() - Method in record class com.marksayson.deletionchecker.manifest.DatasetManifest: Returns a hash code value for this object.
hashCode() - Method in record class com.marksayson.deletionchecker.manifest.EntityTypeEntry: Returns a hash code value for this object.

I

IdentifierCodec - Class in com.marksayson.deletionchecker: Converts identifier strings to the raw bytes used for storage and lookup, enforcing the dataset format's identifier constraints in the process.
identifierCount() - Method in class com.marksayson.deletionchecker.format.PackedDeletionSet: Returns the number of identifiers in this file.
identifierCount() - Method in class com.marksayson.deletionchecker.format.PrefixIndex: Returns the number of identifiers indexed.
identifierCount() - Method in record class com.marksayson.deletionchecker.manifest.EntityTypeEntry: Returns the value of the identifierCount record component.
InvalidManifestException - Exception Class in com.marksayson.deletionchecker.manifest: Thrown when the dataset manifest is not valid JSON, does not match the expected schema, or fails its manifestChecksum.
InvalidManifestException(String) - Constructor for exception class com.marksayson.deletionchecker.manifest.InvalidManifestException: Creates the exception.
isDeleted(String, String) - Method in class com.marksayson.deletionchecker.DeletionChecker: Returns whether id is recorded as deleted for entityType.

L

lexicographicalCompare(byte[], byte[]) - Static method in class com.marksayson.deletionchecker.UnsignedBytes: Compares two byte arrays.
lexicographicalCompare(byte[], int, int, byte[], int, int) - Static method in class com.marksayson.deletionchecker.UnsignedBytes: Compares a range of one byte array against a range of another.
lexicographicalCompare(byte[], int, int, ByteBuffer, int, int) - Static method in class com.marksayson.deletionchecker.UnsignedBytes: Compares a range of a byte array against a range of a ByteBuffer, reading the buffer by absolute index without disturbing its position or limit.
load(Path, Set<String>) - Static method in class com.marksayson.deletionchecker.DeletionChecker: Loads the requested entity types from the dataset in datasetDirectory.
loadedAt() - Method in class com.marksayson.deletionchecker.DeletionChecker: Returns the instant DeletionChecker.load(java.nio.file.Path, java.util.Set<java.lang.String>) completed, i.e.

M

ManifestCanonicalizer - Class in com.marksayson.deletionchecker.manifest: Serializes a manifest to its canonical JSON form: keys in ascending order, no insignificant whitespace, and the manifestChecksum field omitted.
ManifestWriter - Class in com.marksayson.deletionchecker.manifest: Renders a manifest to the JSON written to disk: the canonical form (keys ascending, no insignificant whitespace) with a trailing manifestChecksum field holding the SHA-256 of the canonical form without that field.
MAX_ENTITY_TYPE_LENGTH - Static variable in record class com.marksayson.deletionchecker.manifest.EntityTypeEntry: Maximum length, in ASCII characters, of EntityTypeEntry.entityType.
MAX_IDENTIFIER_BYTES - Static variable in class com.marksayson.deletionchecker.IdentifierCodec: Maximum length, in UTF-8 encoded bytes, of a valid identifier.

O

of(byte[]) - Static method in class com.marksayson.deletionchecker.checksum.Crc32c: Returns the CRC32C of data.
of(byte[]) - Static method in class com.marksayson.deletionchecker.checksum.Sha256: Returns the SHA-256 digest of data.
of(ByteBuffer) - Static method in class com.marksayson.deletionchecker.checksum.Crc32c: Returns the CRC32C of data's remaining bytes, leaving its position and limit unchanged.
open(Path, String) - Static method in class com.marksayson.deletionchecker.format.PackedDeletionSet: Maps and validates the packed file at path.

P

PackedDeletionSet - Class in com.marksayson.deletionchecker.format: One entity type's packed file, memory-mapped and queried for exact membership.
PackedFileWriter - Class in com.marksayson.deletionchecker.format: Serializes one entity type's identifiers into a packed binary file (format v2): header, prefix index, Bloom filter, identifier offset table, identifier data, with the file's CRC32C patched into the header.
PrefixIndex - Class in com.marksayson.deletionchecker.format: Adaptive, equal-count bucket index over a sorted identifier list.

R

read(Path) - Static method in record class com.marksayson.deletionchecker.manifest.DatasetManifest: Reads and verifies the manifest at path.

S

selectBucket(byte[]) - Method in class com.marksayson.deletionchecker.format.PrefixIndex: Selects the candidate bucket for query: the greatest bucket index whose separator is <= query by unsigned byte order, or 0 when query precedes every separator.
separatorData() - Method in class com.marksayson.deletionchecker.format.PrefixIndex: Returns a copy of the contiguous separatorData block: every bucket's separator bytes stored back to back in bucket order.
separatorOffset() - Method in class com.marksayson.deletionchecker.format.PrefixIndex: Returns a copy of the separatorOffset table: bucketCount + 1 byte offsets into PrefixIndex.separatorData(), one per separator plus a trailing total length.
Sha256 - Class in com.marksayson.deletionchecker.checksum: SHA-256 digest, used for the dataset manifest's checksum.
startIndex() - Method in class com.marksayson.deletionchecker.format.PrefixIndex: Returns a copy of the startIndex table: bucketCount + 1 entries, the last equal to PrefixIndex.identifierCount().
supported() - Method in exception class com.marksayson.deletionchecker.format.UnsupportedFormatVersionException: Returns the format version this build understands.
supported() - Method in exception class com.marksayson.deletionchecker.manifest.UnsupportedManifestVersionException: Returns the formatVersion this build understands.
SUPPORTED_FORMAT_VERSION - Static variable in record class com.marksayson.deletionchecker.manifest.DatasetManifest: The manifest JSON schema version this build reads and writes.

T

toString() - Method in record class com.marksayson.deletionchecker.manifest.DatasetManifest: Returns a string representation of this record class.
toString() - Method in record class com.marksayson.deletionchecker.manifest.EntityTypeEntry: Returns a string representation of this record class.

U

UnsignedBytes - Class in com.marksayson.deletionchecker: Lexicographic comparison of byte sequences with each byte treated as unsigned (0..255).
UnsupportedFormatVersionException - Exception Class in com.marksayson.deletionchecker.format: Thrown when a dataset file's format version is not the one this build understands — the artifact is too old or too new for this runtime.
UnsupportedFormatVersionException(int, int) - Constructor for exception class com.marksayson.deletionchecker.format.UnsupportedFormatVersionException: Creates the exception.
UnsupportedManifestVersionException - Exception Class in com.marksayson.deletionchecker.manifest: Thrown when the manifest's formatVersion is not the JSON schema version this build understands — the artifact is too old or too new for this runtime.
UnsupportedManifestVersionException(int, int) - Constructor for exception class com.marksayson.deletionchecker.manifest.UnsupportedManifestVersionException: Creates the exception.

W

write(DatasetManifest) - Static method in class com.marksayson.deletionchecker.manifest.ManifestWriter: Returns the on-disk JSON for manifest.
write(String, List<byte[]>) - Static method in class com.marksayson.deletionchecker.format.PackedFileWriter: Serializes a packed file using PrefixIndex.DEFAULT_BUCKET_SIZE and PackedFileWriter.DEFAULT_BLOOM_FPR.
write(String, List<byte[]>, int) - Static method in class com.marksayson.deletionchecker.format.PackedFileWriter: Serializes a packed file with PackedFileWriter.DEFAULT_BLOOM_FPR.
write(String, List<byte[]>, int, double) - Static method in class com.marksayson.deletionchecker.format.PackedFileWriter: Serializes a packed file.

B C D E F G H I L M O P R S T U W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form