Record Class UpdateInformation

java.lang.Object
java.lang.Record
nl.pim16aap2.animatedarchitecture.core.util.updater.UpdateInformation
Record Components:
updateCheckResult - The result of the update check.
newVersion - The new version that is available as update.

This will be the same as the current version if the result is UpdateCheckResult.UP_TO_DATE.

In case an error occurred while checking for updates, this will be null.

updateUrl - The url of the page where the update can be downloaded from.

In case an error occurred while checking for updates, this will be null.

updateName - The name of the update.

In case an error occurred while checking for updates, this will be null.

public record UpdateInformation(UpdateCheckResult updateCheckResult, @Nullable org.semver4j.Semver newVersion, @Nullable String updateUrl, @Nullable String updateName) extends Record
Represents information about a potential update for this project.

  • Constructor Details

    • UpdateInformation

      public UpdateInformation(UpdateCheckResult updateCheckResult, @Nullable org.semver4j.Semver newVersion, @Nullable String updateUrl, @Nullable String updateName)
      Creates an instance of a UpdateInformation record class.
      Parameters:
      updateCheckResult - the value for the updateCheckResult record component
      newVersion - the value for the newVersion record component
      updateUrl - the value for the updateUrl record component
      updateName - the value for the updateName record component

  • Method Details

    • ofErrorState

      public static UpdateInformation ofErrorState(UpdateCheckResult updateCheckResult)
      Create a new UpdateInformation object for an error state.
      Parameters:
      updateCheckResult - The result of the update check.
      Throws:
      IllegalArgumentException - If the provided result is not an error-state. See UpdateCheckResult.isError().

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

    • updateCheckResult

      public UpdateCheckResult updateCheckResult()
      Returns the value of the updateCheckResult record component.
      Returns:
      the value of the updateCheckResult record component

    • newVersion

      public @Nullable org.semver4j.Semver newVersion()
      Returns the value of the newVersion record component.
      Returns:
      the value of the newVersion record component

    • updateUrl

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

    • updateName

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