Package com.fancyinnovations.config

Record Class ConfigField<T>

java.lang.Object
java.lang.Record
com.fancyinnovations.config.ConfigField<T>
Type Parameters:
T - the type of the field value
Record Components:
path - the path to the field in the configuration file (e.g., "notifications.mute_version")
description - a description of the field
forRemoval - indicates if this field should be removed
defaultValue - the default value of the field
forceDefault - indicates if the default value should be enforced
type - the class type of the field value
public record ConfigField<T>(String path, String description, boolean forRemoval, T defaultValue, boolean forceDefault, Class<T> type) extends Record
Represents a field in a configuration file.

  • Constructor Details

    • ConfigField

      public ConfigField(String path, String description, boolean forRemoval, T defaultValue, boolean forceDefault, Class<T> type)
      Creates an instance of a ConfigField record class.
      Parameters:
      path - the value for the path record component
      description - the value for the description record component
      forRemoval - the value for the forRemoval record component
      defaultValue - the value for the defaultValue record component
      forceDefault - the value for the forceDefault 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. 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.

    • path

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

    • description

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

    • forRemoval

      public boolean forRemoval()
      Returns the value of the forRemoval record component.
      Returns:
      the value of the forRemoval record component

    • defaultValue

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

    • forceDefault

      public boolean forceDefault()
      Returns the value of the forceDefault record component.
      Returns:
      the value of the forceDefault record component

    • type

      public Class<T> type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component