Package dev.turboism.sdk.storage

Record Class StorageMutationResult

java.lang.Object
java.lang.Record
dev.turboism.sdk.storage.StorageMutationResult
Record Components:
changed - whether the operation changed storage
error - structured failure; only a changed recursive delete may also carry StorageErrorCode.PARTIAL_DELETE
public record StorageMutationResult(boolean changed, Optional<StorageError> error) extends Record
Structured result of a copy, move, or delete operation.

  • Constructor Details

    • StorageMutationResult

      public StorageMutationResult(boolean changed, Optional<StorageError> error)
      Validates the mutation result algebra.
      Parameters:
      changed - whether the mutation changed storage
      error - optional structured error
      Throws:
      NullPointerException - if error is null
      IllegalArgumentException - if an unchanged operation has no error or a changed operation has an error other than partial deletion

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • changed

      public boolean changed()
      Returns the value of the changed record component.
      Returns:
      the value of the changed record component

    • error

      public Optional<StorageError> error()
      Returns the value of the error record component.
      Returns:
      the value of the error record component