Index (helix-delta 0.4.0-SNAPSHOT API)

A B C D E F H I J K M N O P R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

ADD - Enum constant in enum class com.helixframework.delta.DeltaOp: A value was added at the target path.
addedCount() - Method in interface com.helixframework.delta.DeltaSummary: Returns the number of add operations.
addedCount() - Method in class com.helixframework.delta.internal.DefaultDeltaSummary
afterValue() - Method in interface com.helixframework.delta.DeltaChange: Returns the value from the after document, or a redacted/null placeholder when the active options suppress it.
afterValue() - Method in class com.helixframework.delta.internal.DefaultDeltaChange
ancestors() - Method in interface com.helixframework.delta.DeltaChange: Returns the ordered ancestor chain from the root to the parent path.
ancestors() - Method in class com.helixframework.delta.internal.DefaultDeltaChange
ancestors(String) - Static method in class com.helixframework.delta.internal.path.JsonPointerUtil
append(String, String) - Static method in class com.helixframework.delta.internal.path.JsonPointerUtil
apply(JsonNode, DeltaResult) - Method in interface com.helixframework.delta.DeltaEngine: Applies a computed delta to a source document.
apply(JsonNode, DeltaResult) - Method in class com.helixframework.delta.internal.apply.DeltaApplier
apply(JsonNode, DeltaResult) - Method in class com.helixframework.delta.internal.DefaultDeltaEngine
ARRAY_CONTEXT_REQUIRED - Enum constant in enum class com.helixframework.delta.InclusionReason: Array structure was retained to preserve positional context.
ARRAY_ELEMENT_ADDED - Enum constant in enum class com.helixframework.delta.ChangeClassification: Array element exists only in the after document.
ARRAY_ELEMENT_REMOVED - Enum constant in enum class com.helixframework.delta.ChangeClassification: Array element exists only in the before document.
ARRAY_ELEMENT_REPLACED - Enum constant in enum class com.helixframework.delta.ChangeClassification: Array element changed in place.
arrayIndex(String) - Static method in class com.helixframework.delta.internal.path.JsonPointerUtil
arrayMatchingStrategy() - Method in class com.helixframework.delta.DeltaOptions: Returns the array comparison strategy used during diff computation.
arrayMatchingStrategy(ArrayMatchingStrategy) - Method in class com.helixframework.delta.DeltaOptions.Builder: Configures how arrays are matched while diffing.
ArrayMatchingStrategy - Enum Class in com.helixframework.delta: Defines how arrays are compared while computing a delta.

B

beforeValue() - Method in interface com.helixframework.delta.DeltaChange: Returns the value from the before document, or a redacted/null placeholder when the active options suppress it.
beforeValue() - Method in class com.helixframework.delta.internal.DefaultDeltaChange
build() - Method in class com.helixframework.delta.DeltaOptions.Builder: Builds an immutable DeltaOptions instance.
build(List<? extends DeltaChange>) - Method in class com.helixframework.delta.internal.projection.ProjectionBuilder
builder() - Static method in class com.helixframework.delta.DeltaOptions: Creates a new builder initialized with the library defaults.
Builder() - Constructor for class com.helixframework.delta.DeltaOptions.Builder

C

ChangeClassification - Enum Class in com.helixframework.delta: Describes the structural kind of an individual delta change.
changeCount() - Method in interface com.helixframework.delta.DeltaSummary: Returns the total number of atomic changes.
changeCount() - Method in class com.helixframework.delta.internal.DefaultDeltaSummary
changed() - Method in interface com.helixframework.delta.DeltaSummary: Returns whether any changes were detected.
changed() - Method in class com.helixframework.delta.internal.DefaultDeltaSummary
changes() - Method in interface com.helixframework.delta.DeltaResult: Returns the ordered atomic changes that make up this delta.
changes() - Method in class com.helixframework.delta.internal.DefaultDeltaResult
classification() - Method in interface com.helixframework.delta.DeltaChange: Returns the structural classification of the change.
classification() - Method in class com.helixframework.delta.internal.DefaultDeltaChange
com.helixframework.delta - package com.helixframework.delta
com.helixframework.delta.internal - package com.helixframework.delta.internal
com.helixframework.delta.internal.apply - package com.helixframework.delta.internal.apply
com.helixframework.delta.internal.compute - package com.helixframework.delta.internal.compute
com.helixframework.delta.internal.path - package com.helixframework.delta.internal.path
com.helixframework.delta.internal.projection - package com.helixframework.delta.internal.projection
comparePathsForDisplay(DeltaChange, DeltaChange) - Static method in class com.helixframework.delta.internal.path.JsonPointerUtil
compute(JsonNode, JsonNode) - Method in interface com.helixframework.delta.DeltaEngine: Computes a deterministic delta between two Jackson trees.
compute(JsonNode, JsonNode) - Method in class com.helixframework.delta.internal.compute.DeltaComputer
compute(JsonNode, JsonNode) - Method in class com.helixframework.delta.internal.DefaultDeltaEngine
compute(String, String) - Method in interface com.helixframework.delta.DeltaEngine: Parses two JSON strings and computes a deterministic delta between them.
compute(String, String) - Method in class com.helixframework.delta.internal.DefaultDeltaEngine
containsArrayIndex(String) - Static method in class com.helixframework.delta.internal.path.JsonPointerUtil
create(DeltaOptions) - Static method in class com.helixframework.delta.DeltaEngines: Creates an engine configured with the supplied options.
createdAt() - Method in interface com.helixframework.delta.DeltaResult: Returns when the delta result was created.
createdAt() - Method in class com.helixframework.delta.internal.DefaultDeltaResult
createDefault() - Static method in class com.helixframework.delta.DeltaEngines: Creates an engine configured with the library defaults.

D

DefaultDeltaChange - Class in com.helixframework.delta.internal
DefaultDeltaChange(DeltaOp, String, String, List<String>, JsonNode, JsonNode, ChangeClassification, InclusionReason, String) - Constructor for class com.helixframework.delta.internal.DefaultDeltaChange
DefaultDeltaEngine - Class in com.helixframework.delta.internal
DefaultDeltaEngine(DeltaOptions) - Constructor for class com.helixframework.delta.internal.DefaultDeltaEngine
DefaultDeltaResult - Class in com.helixframework.delta.internal
DefaultDeltaResult(ObjectMapper, String, Instant, DeltaSummary, JsonNode, List<DeltaChange>, JsonNode) - Constructor for class com.helixframework.delta.internal.DefaultDeltaResult
DefaultDeltaSummary - Class in com.helixframework.delta.internal
DefaultDeltaSummary(boolean, int, int, int, int) - Constructor for class com.helixframework.delta.internal.DefaultDeltaSummary
DeltaApplier - Class in com.helixframework.delta.internal.apply
DeltaApplier(ObjectMapper) - Constructor for class com.helixframework.delta.internal.apply.DeltaApplier
DeltaApplyException - Exception in com.helixframework.delta: Thrown when a previously computed delta cannot be replayed onto an input document.
DeltaApplyException(String) - Constructor for exception com.helixframework.delta.DeltaApplyException: Creates an exception with a message describing the replay failure.
DeltaApplyException(String, Throwable) - Constructor for exception com.helixframework.delta.DeltaApplyException: Creates an exception with a message and the underlying cause.
DeltaChange - Interface in com.helixframework.delta: One atomic add, remove, or replace operation in a computed delta.
DeltaComputationException - Exception in com.helixframework.delta: Thrown when delta computation cannot be completed for a valid input pair.
DeltaComputationException(String) - Constructor for exception com.helixframework.delta.DeltaComputationException: Creates an exception with a computation failure message.
DeltaComputationException(String, Throwable) - Constructor for exception com.helixframework.delta.DeltaComputationException: Creates an exception with a computation failure message and cause.
DeltaComputer - Class in com.helixframework.delta.internal.compute
DeltaComputer(DeltaOptions, ObjectMapper) - Constructor for class com.helixframework.delta.internal.compute.DeltaComputer
DeltaEngine - Interface in com.helixframework.delta: Computes replayable deltas between two JSON documents and applies them later.
DeltaEngines - Class in com.helixframework.delta: Factory methods for creating DeltaEngine instances.
deltaId() - Method in interface com.helixframework.delta.DeltaResult: Returns a generated identifier for this delta result.
deltaId() - Method in class com.helixframework.delta.internal.DefaultDeltaResult
DeltaOp - Enum Class in com.helixframework.delta: Normalized operation types emitted by the delta engine.
DeltaOptions - Class in com.helixframework.delta: Immutable options that control delta computation, projection generation, and value visibility.
DeltaOptions.Builder - Class in com.helixframework.delta: Builder for DeltaOptions.
DeltaResult - Interface in com.helixframework.delta: The full output of comparing two JSON documents.
DeltaSummary - Interface in com.helixframework.delta: Summary counts for a computed delta.

E

escape(String) - Static method in class com.helixframework.delta.internal.path.JsonPointerUtil
explain() - Method in interface com.helixframework.delta.DeltaChange: Returns a human-readable explanation suitable for logs and audit output.
explain() - Method in class com.helixframework.delta.internal.DefaultDeltaChange

F

formatVersion() - Method in interface com.helixframework.delta.DeltaResult: Returns the serialized delta format version.
formatVersion() - Method in class com.helixframework.delta.internal.DefaultDeltaResult

H

hasChanges() - Method in interface com.helixframework.delta.DeltaResult: Returns whether the compared documents differ.
hasChanges() - Method in class com.helixframework.delta.internal.DefaultDeltaResult

I

ignoredPaths() - Method in class com.helixframework.delta.DeltaOptions: Returns paths that should be omitted entirely from comparison output.
ignoredPaths(Set<String>) - Method in class com.helixframework.delta.DeltaOptions.Builder: Configures exact or subtree paths that should be skipped entirely.
includeAfterValues() - Method in class com.helixframework.delta.DeltaOptions: Returns whether after values are included in each DeltaChange.
includeAfterValues(boolean) - Method in class com.helixframework.delta.DeltaOptions.Builder: Controls whether after values are exposed in emitted changes.
includeAncestors() - Method in class com.helixframework.delta.DeltaOptions: Returns whether ancestor paths are attached to each change.
includeAncestors(boolean) - Method in class com.helixframework.delta.DeltaOptions.Builder: Controls whether ancestor chains are attached to emitted changes.
includeBeforeValues() - Method in class com.helixframework.delta.DeltaOptions: Returns whether before values are included in each DeltaChange.
includeBeforeValues(boolean) - Method in class com.helixframework.delta.DeltaOptions.Builder: Controls whether before values are exposed in emitted changes.
includeProjection() - Method in class com.helixframework.delta.DeltaOptions: Returns whether a changed-only projection is produced.
includeProjection(boolean) - Method in class com.helixframework.delta.DeltaOptions.Builder: Controls whether a changed-only projection is generated.
inclusionReason() - Method in interface com.helixframework.delta.DeltaChange: Returns why this path was included in the delta output.
inclusionReason() - Method in class com.helixframework.delta.internal.DefaultDeltaChange
InclusionReason - Enum Class in com.helixframework.delta: Explains why a path appears in the delta output.
InvalidJsonException - Exception in com.helixframework.delta: Thrown when JSON input cannot be parsed into a Jackson tree.
InvalidJsonException(String) - Constructor for exception com.helixframework.delta.InvalidJsonException: Creates an exception with a parse failure message.
InvalidJsonException(String, Throwable) - Constructor for exception com.helixframework.delta.InvalidJsonException: Creates an exception with a parse failure message and cause.
isArrayIndex(String) - Static method in class com.helixframework.delta.internal.path.JsonPointerUtil

J

JsonPointerUtil - Class in com.helixframework.delta.internal.path

K

KEY_ADDED - Enum constant in enum class com.helixframework.delta.InclusionReason: The key exists only in the after document.
KEY_REMOVED - Enum constant in enum class com.helixframework.delta.InclusionReason: The key exists only in the before document.

M

matchesOrContains(String, String) - Static method in class com.helixframework.delta.internal.path.JsonPointerUtil

N

normalizeNumbers() - Method in class com.helixframework.delta.DeltaOptions: Returns whether numerically equivalent values such as 1 and 1.0 are treated as equal.
normalizeNumbers(boolean) - Method in class com.helixframework.delta.DeltaOptions.Builder: Controls whether numerically equivalent values should compare equal.

O

OBJECT_FIELD_ADDED - Enum constant in enum class com.helixframework.delta.ChangeClassification: Object field exists only in the after document.
OBJECT_FIELD_REMOVED - Enum constant in enum class com.helixframework.delta.ChangeClassification: Object field exists only in the before document.
OBJECT_FIELD_REPLACED - Enum constant in enum class com.helixframework.delta.ChangeClassification: Object field was replaced as a whole subtree.
op() - Method in interface com.helixframework.delta.DeltaChange: Returns the normalized operation represented by this change.
op() - Method in class com.helixframework.delta.internal.DefaultDeltaChange

P

PARENT_RETAINED_FOR_TRACEABILITY - Enum constant in enum class com.helixframework.delta.InclusionReason: Parent container was retained to preserve reachability to a changed node.
parentPath() - Method in interface com.helixframework.delta.DeltaChange: Returns the parent path that directly contains the changed node.
parentPath() - Method in class com.helixframework.delta.internal.DefaultDeltaChange
parentPath(String) - Static method in class com.helixframework.delta.internal.path.JsonPointerUtil
path() - Method in interface com.helixframework.delta.DeltaChange: Returns the absolute JSON Pointer path for this change.
path() - Method in class com.helixframework.delta.internal.DefaultDeltaChange
POSITIONAL - Enum constant in enum class com.helixframework.delta.ArrayMatchingStrategy: Compares array elements by their numeric index.
projection() - Method in interface com.helixframework.delta.DeltaResult: Returns the minimal changed-only projection, or a null node when no projection is available.
projection() - Method in class com.helixframework.delta.internal.DefaultDeltaResult
ProjectionBuilder - Class in com.helixframework.delta.internal.projection
ProjectionBuilder(ObjectMapper) - Constructor for class com.helixframework.delta.internal.projection.ProjectionBuilder
putValueAtPath(ObjectNode, String, JsonNode, JsonNodeFactory) - Static method in class com.helixframework.delta.internal.path.JsonPointerUtil

R

redactedPaths() - Method in class com.helixframework.delta.DeltaOptions: Returns paths whose values should be replaced with a redaction marker.
redactedPaths(Set<String>) - Method in class com.helixframework.delta.DeltaOptions.Builder: Configures exact or subtree paths whose values should be redacted.
REMOVE - Enum constant in enum class com.helixframework.delta.DeltaOp: A value was removed from the target path.
removedCount() - Method in interface com.helixframework.delta.DeltaSummary: Returns the number of remove operations.
removedCount() - Method in class com.helixframework.delta.internal.DefaultDeltaSummary
REPLACE - Enum constant in enum class com.helixframework.delta.DeltaOp: A value was replaced at the target path.
replacedCount() - Method in interface com.helixframework.delta.DeltaSummary: Returns the number of replace operations.
replacedCount() - Method in class com.helixframework.delta.internal.DefaultDeltaSummary
ROOT_PATH - Static variable in class com.helixframework.delta.internal.path.JsonPointerUtil
ROOT_REPLACED - Enum constant in enum class com.helixframework.delta.ChangeClassification: The entire root document was replaced.

S

SCALAR_VALUE_CHANGED - Enum constant in enum class com.helixframework.delta.ChangeClassification: Scalar value changed without a container shape change.
summary() - Method in interface com.helixframework.delta.DeltaResult: Returns summary counts derived from the atomic change list.
summary() - Method in class com.helixframework.delta.internal.DefaultDeltaResult

T

toJson() - Method in interface com.helixframework.delta.DeltaResult: Serializes this result into the stable Helix Delta JSON shape.
toJson() - Method in class com.helixframework.delta.internal.DefaultDeltaResult
toJsonPatch() - Method in interface com.helixframework.delta.DeltaResult: Returns a JSON Patch representation when every change can be expressed as RFC 6902 add/remove/replace operations.
toJsonPatch() - Method in class com.helixframework.delta.internal.DefaultDeltaResult
tokens(String) - Static method in class com.helixframework.delta.internal.path.JsonPointerUtil
toMergePatch() - Method in interface com.helixframework.delta.DeltaResult: Returns a JSON Merge Patch representation when it can be produced without losing semantics.
toMergePatch() - Method in class com.helixframework.delta.internal.DefaultDeltaResult
TYPE_CHANGED - Enum constant in enum class com.helixframework.delta.ChangeClassification: The JSON node type changed at the path.
TYPE_CHANGED - Enum constant in enum class com.helixframework.delta.InclusionReason: The node type changed at the path.

U

unescape(String) - Static method in class com.helixframework.delta.internal.path.JsonPointerUtil
UnsupportedDeltaFormatException - Exception in com.helixframework.delta: Thrown when serialized delta input uses a format version the library does not support.
UnsupportedDeltaFormatException(String) - Constructor for exception com.helixframework.delta.UnsupportedDeltaFormatException: Creates an exception with a format compatibility message.

V

VALUE_CHANGED - Enum constant in enum class com.helixframework.delta.InclusionReason: The value at the path changed in place.
valueOf(String) - Static method in enum class com.helixframework.delta.ArrayMatchingStrategy: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.helixframework.delta.ChangeClassification: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.helixframework.delta.DeltaOp: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.helixframework.delta.InclusionReason: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.helixframework.delta.ArrayMatchingStrategy: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.helixframework.delta.ChangeClassification: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.helixframework.delta.DeltaOp: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.helixframework.delta.InclusionReason: Returns an array containing the constants of this enum class, in the order they are declared.

A B C D E F H I J K M N O P R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form