Package com.patbaumgartner.spring.migrator.core

Record Class MigrationChange

java.lang.Object
java.lang.Record
com.patbaumgartner.spring.migrator.core.MigrationChange
Record Components:
file - the file path relative to the project root
line - the one-based line the key appears on
key - the deprecated key exactly as the user wrote it
replacement - the property to migrate to, or null when there is none
outcome - what the migrator decided to do
reason - the deprecation reason recorded in the metadata, or null
advice - why manual action is required, or null when none is
public record MigrationChange(String file, int line, String key, String replacement, Outcome outcome, String reason, String advice) extends Record
One deprecated property found in one configuration file.

  • Constructor Details

    • MigrationChange

      public MigrationChange(String file, int line, String key, String replacement, Outcome outcome, String reason, String advice)
      Creates an instance of a MigrationChange record class.
      Parameters:
      file - the value for the file record component
      line - the value for the line record component
      key - the value for the key record component
      replacement - the value for the replacement record component
      outcome - the value for the outcome record component
      reason - the value for the reason record component
      advice - the value for the advice record component

  • Method Details

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

    • file

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

    • line

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

    • key

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

    • replacement

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

    • outcome

      public Outcome outcome()
      Returns the value of the outcome record component.
      Returns:
      the value of the outcome record component

    • reason

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

    • advice

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