Record Class VersionChecker.CheckResult

java.lang.Object
java.lang.Record
net.neoforged.neoforge.common.VersionChecker.CheckResult
Record Components:
status - the check status
target - the target version which was used to determine the check status, or null if there is no target
changes - the map of versions to changelog entries, for all versions between the current version and the target version
url - the homepage url taken from the update checker data, which may be null if not present
Enclosing class:
VersionChecker

public static record VersionChecker.CheckResult(VersionChecker.Status status, @Nullable org.apache.maven.artifact.versioning.ComparableVersion target, Map<org.apache.maven.artifact.versioning.ComparableVersion, String> changes, @Nullable String url) extends Record
The version check result for a given mod. The mod which this check result belongs to is provided elsewhere.
  • Field Details

    • status

      private final VersionChecker.Status status
      The field for the status record component.
    • target

      private final @Nullable org.apache.maven.artifact.versioning.ComparableVersion target
      The field for the target record component.
    • changes

      private final Map<org.apache.maven.artifact.versioning.ComparableVersion, String> changes
      The field for the changes record component.
    • url

      private final @Nullable String url
      The field for the url record component.
  • Constructor Details

    • CheckResult

      public CheckResult(VersionChecker.Status status, @Nullable org.apache.maven.artifact.versioning.ComparableVersion target, Map<org.apache.maven.artifact.versioning.ComparableVersion, String> changes, @Nullable String url)
      Creates an instance of a CheckResult record class.
      Parameters:
      status - the value for the status record component
      target - the value for the target record component
      changes - the value for the changes record component
      url - the value for the url 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.
    • status

      public VersionChecker.Status status()
      Returns the value of the status record component.
      Returns:
      the value of the status record component
    • target

      public @Nullable org.apache.maven.artifact.versioning.ComparableVersion target()
      Returns the value of the target record component.
      Returns:
      the value of the target record component
    • changes

      public Map<org.apache.maven.artifact.versioning.ComparableVersion, String> changes()
      Returns the value of the changes record component.
      Returns:
      the value of the changes record component
    • url

      public @Nullable String url()
      Returns the value of the url record component.
      Returns:
      the value of the url record component