Package lu.kbra.modelizer_next.history

Record Class DocumentSnapshot

java.lang.Object
java.lang.Record
lu.kbra.modelizer_next.history.DocumentSnapshot
Record Components:
json - JSON text or node to read
public record DocumentSnapshot(String json) extends Record
Immutable undo/redo snapshot containing a serialized document state and a user-facing description.

  • Constructor Details

    • DocumentSnapshot

      public DocumentSnapshot(String json)
      Creates an instance of a DocumentSnapshot record class.
      Parameters:
      json - the value for the json record component

  • Method Details

    • from

      public static DocumentSnapshot from(ModelDocument document)
      Creates a value from the supplied input.
      Parameters:
      document - document to read or modify
      Returns:
      the from result

    • sameDocumentState

      public boolean sameDocumentState(ModelDocument document)
      Checks whether the document state is the same.
      Parameters:
      document - document to read or modify
      Returns:
      true when the condition is met; otherwise false

    • restoreInto

      public void restoreInto(ModelDocument target)
      Restores the into.
      Parameters:
      target - target value used by the operation

    • 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • json

      public String json()
      Returns the value of the json record component.
      Returns:
      the value of the json record component