Package com.helixframework.delta

Interface DeltaChange

All Known Implementing Classes:
DefaultDeltaChange
public interface DeltaChange
One atomic add, remove, or replace operation in a computed delta.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.fasterxml.jackson.databind.JsonNode
    afterValue()
    Returns the value from the after document, or a redacted/null placeholder when the active options suppress it.
    List<String>
    ancestors()
    Returns the ordered ancestor chain from the root to the parent path.
    com.fasterxml.jackson.databind.JsonNode
    beforeValue()
    Returns the value from the before document, or a redacted/null placeholder when the active options suppress it.
    ChangeClassification
    classification()
    Returns the structural classification of the change.
    String
    explain()
    Returns a human-readable explanation suitable for logs and audit output.
    InclusionReason
    inclusionReason()
    Returns why this path was included in the delta output.
    DeltaOp
    op()
    Returns the normalized operation represented by this change.
    String
    parentPath()
    Returns the parent path that directly contains the changed node.
    String
    path()
    Returns the absolute JSON Pointer path for this change.

  • Method Details

    • op

      DeltaOp op()
      Returns the normalized operation represented by this change.
      Returns:
      delta operation

    • path

      String path()
      Returns the absolute JSON Pointer path for this change.
      Returns:
      changed path

    • parentPath

      String parentPath()
      Returns the parent path that directly contains the changed node.
      Returns:
      parent path

    • ancestors

      List<String> ancestors()
      Returns the ordered ancestor chain from the root to the parent path.
      Returns:
      ancestor paths

    • beforeValue

      com.fasterxml.jackson.databind.JsonNode beforeValue()
      Returns the value from the before document, or a redacted/null placeholder when the active options suppress it.
      Returns:
      before value view

    • afterValue

      com.fasterxml.jackson.databind.JsonNode afterValue()
      Returns the value from the after document, or a redacted/null placeholder when the active options suppress it.
      Returns:
      after value view

    • classification

      ChangeClassification classification()
      Returns the structural classification of the change.
      Returns:
      change classification

    • inclusionReason

      InclusionReason inclusionReason()
      Returns why this path was included in the delta output.
      Returns:
      inclusion reason

    • explain

      String explain()
      Returns a human-readable explanation suitable for logs and audit output.
      Returns:
      explanation text