Record Class SemverVersion

java.lang.Object
java.lang.Record
org.openhab.core.thing.firmware.types.SemverVersion
Record Components:
major - major version number
minor - minor version number
patch - patch version number

@NonNullByDefault public record SemverVersion(int major, int minor, int patch) extends Record
This class represents a semantic version (semver) with major, minor, and patch components. See Semantic Versioning 2.0 for more details.
Author:
Florian Hotze - Initial contribution
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final SemverVersion
     
  • Constructor Summary

    Constructors
    Constructor
    Description
    SemverVersion(int major, int minor, int patch)
    Creates an instance of a SemverVersion record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    Indicates whether some other object is "equal to" this one.
    fromString(String version)
    Creates a SemverVersion from a valid semver string, i.e.
    final int
    Returns a hash code value for this object.
    boolean
    Checks if this semver version is equal to the other semver version.
    boolean
    Checks if this semver version is greater than the other semver version.
    boolean
    Checks if this semver version is greater than or equal to the other semver version.
    boolean
    Checks if this semver version is less than the other semver version.
    boolean
    Checks if this semver version is less than or equal to the other semver version.
    int
    Returns the value of the major record component.
    int
    Returns the value of the minor record component.
    int
    Returns the value of the patch record component.
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Field Details

  • Constructor Details

    • SemverVersion

      public SemverVersion(int major, int minor, int patch)
      Creates an instance of a SemverVersion record class.
      Parameters:
      major - the value for the major record component
      minor - the value for the minor record component
      patch - the value for the patch record component
  • Method Details

    • fromString

      public static SemverVersion fromString(String version)
      Creates a SemverVersion from a valid semver string, i.e. major.minor.patch.
      Parameters:
      version - the semver string to parse
      Returns:
      a SemverVersion
    • isGreaterThan

      public boolean isGreaterThan(SemverVersion other)
      Checks if this semver version is greater than the other semver version.
      Parameters:
      other - the other semver version to compare with
      Returns:
      true if this version is greater than the other, false otherwise
    • isGreaterThanOrEqualTo

      public boolean isGreaterThanOrEqualTo(SemverVersion other)
      Checks if this semver version is greater than or equal to the other semver version.
      Parameters:
      other - the other semver version to compare with
      Returns:
      true if this version is greater than or equal to the other, false otherwise
    • isLessThan

      public boolean isLessThan(SemverVersion other)
      Checks if this semver version is less than the other semver version.
      Parameters:
      other - the other semver version to compare with
      Returns:
      true if this version is less than the other, false otherwise
    • isLessThanOrEqualTo

      public boolean isLessThanOrEqualTo(SemverVersion other)
      Checks if this semver version is less than or equal to the other semver version.
      Parameters:
      other - the other semver version to compare with
      Returns:
      true if this version is less than or equal to the other, false otherwise
    • isEqualTo

      public boolean isEqualTo(SemverVersion other)
      Checks if this semver version is equal to the other semver version.
      Parameters:
      other - the other semver version to compare with
      Returns:
      true if both versions are equal, false otherwise
    • toString

      public 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 '=='.
      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.
    • major

      public int major()
      Returns the value of the major record component.
      Returns:
      the value of the major record component
    • minor

      public int minor()
      Returns the value of the minor record component.
      Returns:
      the value of the minor record component
    • patch

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