Record Class MigrationResult.MigrationStep

java.lang.Object
java.lang.Record
net.blockhost.commons.config.migration.MigrationResult.MigrationStep
Record Components:
fromVersion - the version before this step
toVersion - the version after this step
description - the description of what the migration did
duration - how long this step took
Enclosing interface:
MigrationResult
public static record MigrationResult.MigrationStep(int fromVersion, int toVersion, String description, Duration duration) extends Record
Represents a single migration step that was applied.

  • Constructor Details

    • MigrationStep

      public MigrationStep(int fromVersion, int toVersion, String description, Duration duration)
      Creates an instance of a MigrationStep record class.
      Parameters:
      fromVersion - the value for the fromVersion record component
      toVersion - the value for the toVersion record component
      description - the value for the description record component
      duration - the value for the duration record component

  • Method Details

    • from

      public static MigrationResult.MigrationStep from(Migration migration, Instant start, Instant end)
      Creates a migration step from a migration and timing information.
      Parameters:
      migration - the migration that was applied
      start - the start time
      end - the end time
      Returns:
      a new migration step

    • 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

    • toVersion

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

    • description

      public String description()
      Returns the value of the description record component.
      Returns:
      the value of the description record component

    • duration

      public Duration duration()
      Returns the value of the duration record component.
      Returns:
      the value of the duration record component