Package com.patbaumgartner.spring.migrator.core

Record Class DeprecatedProperty

java.lang.Object
java.lang.Record
com.patbaumgartner.spring.migrator.core.DeprecatedProperty
Record Components:
key - the canonical name of the deprecated property
replacement - the canonical name of the property that replaces it, or null when there is none
reason - the short reason recorded in the metadata, or null
level - the deprecation level, or null when the metadata omits it
public record DeprecatedProperty(String key, String replacement, String reason, org.springframework.boot.configurationmetadata.Deprecation.Level level) extends Record
A deprecated configuration property as described by Spring Boot configuration metadata.

  • Constructor Summary

    Constructors
    Constructor
    Description
    DeprecatedProperty(String key, String replacement, String reason)
    Creates a deprecation whose level the metadata did not state.
    DeprecatedProperty(String key, String replacement, String reason, org.springframework.boot.configurationmetadata.Deprecation.Level level)
    Creates an instance of a DeprecatedProperty record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    hasReplacement()
    Returns whether the metadata names a property to migrate to.
    boolean
    isRemoved()
    Returns whether the property is already removed rather than merely discouraged.
    String
    key()
    Returns the value of the key record component.
    org.springframework.boot.configurationmetadata.Deprecation.Level
    level()
    Returns the value of the level record component.
    String
    reason()
    Returns the value of the reason record component.
    String
    replacement()
    Returns the value of the replacement record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • DeprecatedProperty

      public DeprecatedProperty(String key, String replacement, String reason)
      Creates a deprecation whose level the metadata did not state.
      Parameters:
      key - the canonical name of the deprecated property
      replacement - the replacement property name, or null
      reason - the short reason, or null

    • DeprecatedProperty

      public DeprecatedProperty(String key, String replacement, String reason, org.springframework.boot.configurationmetadata.Deprecation.Level level)
      Creates an instance of a DeprecatedProperty record class.
      Parameters:
      key - the value for the key record component
      replacement - the value for the replacement record component
      reason - the value for the reason record component
      level - the value for the level record component

  • Method Details

    • hasReplacement

      public boolean hasReplacement()
      Returns whether the metadata names a property to migrate to.
      Returns:
      whether a replacement is available

    • isRemoved

      public boolean isRemoved()
      Returns whether the property is already removed rather than merely discouraged.
      Returns:
      whether the deprecation level is error

    • 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 Objects::equals(Object,Object).
      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.

    • 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

    • reason

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

    • level

      public org.springframework.boot.configurationmetadata.Deprecation.Level level()
      Returns the value of the level record component.
      Returns:
      the value of the level record component