Record Class ContractVersion

java.lang.Object
java.lang.Record
com.blueriq.component.api.externalflow.data.contract.ContractVersion
Record Components:
major - major version
minor - minor version
All Implemented Interfaces:
Comparable<ContractVersion>

public record ContractVersion(int major, int minor) extends Record implements Comparable<ContractVersion>
Contract version for the external flow data models. Contract versions are used to determine which contract mapping should be used when serializing and deserializing external flow data models.
  • Constructor Summary

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

    Modifier and Type
    Method
    Description
    int
    Compare ContractVersions on major and then minor version
    final boolean
    Indicates whether some other object is "equal to" this one.
    final int
    Returns a hash code value for this object.
    int
    Returns the value of the major record component.
    int
    Returns the value of the minor record component.
    final String
    Returns a string representation of this record class.

    Methods inherited from class Object

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

    • ContractVersion

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

    • compareTo

      public int compareTo(ContractVersion otherCv)
      Compare ContractVersions on major and then minor version
      Specified by:
      compareTo in interface Comparable<ContractVersion>
      Parameters:
      otherCv - the ContractVersion to be compared.
      Returns:
      see Comparable.compareTo(Object)
    • 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 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.
    • 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