Record Class DataMigration

java.lang.Object
java.lang.Record
fr.robie.machineengine.api.data.DataMigration
Record Components:
fromVersion - the data version this migration accepts
migration - the upgrade; returns an error result if the data cannot be migrated
public record DataMigration(int fromVersion, @NotNull Function<DataValue, Result<DataValue>> migration) extends Record
Upgrades data from fromVersion() to fromVersion + 1.

  • Constructor Details

    • DataMigration

      public DataMigration(int fromVersion, @NotNull @NotNull Function<DataValue, Result<DataValue>> migration)
      Creates an instance of a DataMigration record class.
      Parameters:
      fromVersion - the value for the fromVersion record component
      migration - the value for the migration record component

  • Method Details

    • apply

      @NotNull public @NotNull Result<DataValue> apply(@NotNull @NotNull DataValue data)

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

    • fromVersion

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

    • migration

      @NotNull public @NotNull Function<DataValue, Result<DataValue>> migration()
      Returns the value of the migration record component.
      Returns:
      the value of the migration record component