Record Class VcsOperations.SyncOutcome

java.lang.Object
java.lang.Record
network.ike.plugin.ws.vcs.VcsOperations.SyncOutcome
Record Components:
selfHealed - true when a stale checkpoint was rewritten to the current HEAD because origin-parity was already independently confirmed
note - text worth surfacing in a caller's report, or null when there is nothing to report
Enclosing class:
VcsOperations
public static record VcsOperations.SyncOutcome(boolean selfHealed, String note) extends Record
Result of VcsOperations.sync(File, Log) / VcsOperations.catchUp(File, Log): whether a stale-but-safe .ike/vcs-state checkpoint was self-healed, and a human-readable note for a goal's markdown report (ike-issues#819).

  • Constructor Summary

    Constructors
    Constructor
    Description
    SyncOutcome(boolean selfHealed, String note)
    Creates an instance of a SyncOutcome record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    note()
    Returns the value of the note record component.
    boolean
    selfHealed()
    Returns the value of the selfHealed record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • SyncOutcome

      public SyncOutcome(boolean selfHealed, String note)
      Creates an instance of a SyncOutcome record class.
      Parameters:
      selfHealed - the value for the selfHealed record component
      note - the value for the note record component

  • 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 the compare method from their corresponding wrapper classes.
      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.

    • selfHealed

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

    • note

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