Package org.apache.polaris.docs.generator

Record Class PolarisConfigurationInfo

java.lang.Object
java.lang.Record
org.apache.polaris.docs.generator.PolarisConfigurationInfo
public record PolarisConfigurationInfo(String propertyName, String description, String defaultValue, @Nullable String catalogConfig, String type) extends Record
Holds information about a PolarisConfiguration (FeatureConfiguration or BehaviorChangeConfiguration) extracted from static fields.

  • Constructor Details

    • PolarisConfigurationInfo

      public PolarisConfigurationInfo(String propertyName, String description, String defaultValue, @Nullable String catalogConfig, String type)
      Creates an instance of a PolarisConfigurationInfo record class.
      Parameters:
      propertyName - the value for the propertyName record component
      description - the value for the description record component
      defaultValue - the value for the defaultValue record component
      catalogConfig - the value for the catalogConfig record component
      type - the value for the type 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. 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.

    • propertyName

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

    • description

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

    • defaultValue

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

    • catalogConfig

      public @Nullable String catalogConfig()
      Returns the value of the catalogConfig record component.
      Returns:
      the value of the catalogConfig record component

    • type

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