Record Class PushResult

java.lang.Object
java.lang.Record
fr.robie.machineengine.api.machine.PushResult
Record Components:
moved - amount that left this machine: delivered directly, or placed in escrow for a cross-region handoff (ยง16.3)
public record PushResult(@NotNull PushResult.Kind kind, long moved) extends Record
Outcome of MachineContext.push(RelativeSide, String, Predicate, long).

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    PushResult.Kind
     

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final PushResult
    BUSY
     
    static final PushResult
    NO_TARGET
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    PushResult(@NotNull PushResult.Kind kind, long moved)
    Creates an instance of a PushResult 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.
    @NotNull PushResult.Kind
    kind()
    Returns the value of the kind record component.
    long
    moved()
    Returns the value of the moved 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

  • Field Details

  • Constructor Details

    • PushResult

      public PushResult(@NotNull @NotNull PushResult.Kind kind, long moved)
      Creates an instance of a PushResult record class.
      Parameters:
      kind - the value for the kind record component
      moved - the value for the moved 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.

    • kind

      @NotNull public @NotNull PushResult.Kind kind()
      Returns the value of the kind record component.
      Returns:
      the value of the kind record component

    • moved

      public long moved()
      Returns the value of the moved record component.
      Returns:
      the value of the moved record component