Package com.cleanroommc.versioning

Record Class GitState

java.lang.Object
java.lang.Record
com.cleanroommc.versioning.GitState
Record Components:
latestTag - the highest numeric tag reachable from HEAD, or null before the first tag
target - the version the current branch leads to, or null outside a development branch
distance - commits between the baseline tag and HEAD, or the total commit count without a tag
dirty - whether the worktree has uncommitted changes
pushed - whether HEAD is contained in a remote-tracking ref
All Implemented Interfaces:
Serializable
public record GitState(SemanticVersion latestTag, SemanticVersion target, long distance, boolean dirty, boolean pushed) extends Record implements Serializable
Git inputs used to calculate a version.
See Also:

  • Constructor Details

    • GitState

      public GitState(SemanticVersion latestTag, SemanticVersion target, long distance, boolean dirty, boolean pushed)
      Creates an instance of a GitState record class.
      Parameters:
      latestTag - the value for the latestTag record component
      target - the value for the target record component
      distance - the value for the distance record component
      dirty - the value for the dirty record component
      pushed - the value for the pushed record component

  • Method Details

    • exactTag

      public boolean exactTag()
      Returns:
      whether HEAD is the baseline tag itself

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

    • latestTag

      public SemanticVersion latestTag()
      Returns the value of the latestTag record component.
      Returns:
      the value of the latestTag record component

    • target

      public SemanticVersion target()
      Returns the value of the target record component.
      Returns:
      the value of the target record component

    • distance

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

    • dirty

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

    • pushed

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