Record Class BuildDataReader.BuildData

java.lang.Object
java.lang.Record
nl.pim16aap2.animatedarchitecture.core.util.versioning.BuildDataReader.BuildData
Record Components:
git - The git data with the branch, commit hash, dirty status (i.e. modified version of the commit), and commit time.
buildNumber - The number of the build. Using GitHub Actions (which we do), this refers to GITHUB_RUN_NUMBER. This number is incremented for each new run of a particular workflow.
buildId - The unique id of the build. Using GitHub Actions, this refers to GITHUB_RUN_ID.
Enclosing class:
BuildDataReader
public static record BuildDataReader.BuildData(String git, long buildNumber, long buildId) extends Record
A description of the build data of the current build.

  • Constructor Summary

    Constructors
    Constructor
    Description
    BuildData(String git, long buildNumber, long buildId)
    Creates an instance of a BuildData record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    buildId()
    Returns the value of the buildId record component.
    long
    buildNumber()
    Returns the value of the buildNumber record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    String
    git()
    Returns the value of the git record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    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

    • BuildData

      public BuildData(String git, long buildNumber, long buildId)
      Creates an instance of a BuildData record class.
      Parameters:
      git - the value for the git record component
      buildNumber - the value for the buildNumber record component
      buildId - the value for the buildId 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.

    • git

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

    • buildNumber

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

    • buildId

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