Record Class WalkPass

java.lang.Object
java.lang.Record
build.jenesis.repository.walk.WalkPass
public record WalkPass(long generation, Instant started, List<String> roots, int segments, int done, WalkPass.Status status) extends Record
One walk pass as recorded in the consumer's manifest (walks/<consumer>/manifest): a monotonically increasing generation (the pass id every segment claim embeds, so a stale segment object from an earlier pass is recognisably reclaimable), the roots the pass enumerates, when it started, how its segments stand, and whether it is still running. The pass is complete when every segment is done; the last finisher flips the manifest, and the next ArtifactWalk.walk(ArtifactStore, String, List, ArtifactWalk.KeyVisitor) then starts generation + 1.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    WalkPass.Status
    A pass is running until its last segment is done.

  • Constructor Summary

    Constructors
    Constructor
    Description
    WalkPass(long generation, Instant started, List<String> roots, int segments, int done, WalkPass.Status status)
    Creates an instance of a WalkPass record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    complete()
    Whether the pass has enumerated everything - the onPassCompleted moment for a consumer that commits or compacts at pass end.
    int
    done()
    Returns the value of the done record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    long
    generation()
    Returns the value of the generation record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    List<String>
    roots()
    Returns the value of the roots record component.
    int
    segments()
    Returns the value of the segments record component.
    Instant
    started()
    Returns the value of the started record component.
    WalkPass.Status
    status()
    Returns the value of the status 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

    • WalkPass

      public WalkPass(long generation, Instant started, List<String> roots, int segments, int done, WalkPass.Status status)
      Creates an instance of a WalkPass record class.
      Parameters:
      generation - the value for the generation record component
      started - the value for the started record component
      roots - the value for the roots record component
      segments - the value for the segments record component
      done - the value for the done record component
      status - the value for the status record component

  • Method Details

    • complete

      public boolean complete()
      Whether the pass has enumerated everything - the onPassCompleted moment for a consumer that commits or compacts at pass end.

    • 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.

    • generation

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

    • started

      public Instant started()
      Returns the value of the started record component.
      Returns:
      the value of the started record component

    • roots

      public List<String> roots()
      Returns the value of the roots record component.
      Returns:
      the value of the roots record component

    • segments

      public int segments()
      Returns the value of the segments record component.
      Returns:
      the value of the segments record component

    • done

      public int done()
      Returns the value of the done record component.
      Returns:
      the value of the done record component

    • status

      public WalkPass.Status status()
      Returns the value of the status record component.
      Returns:
      the value of the status record component