Package com.github.joschi.jadconfig.documentation

Record Class ConfigurationEntry

java.lang.Object
java.lang.Record
com.github.joschi.jadconfig.documentation.ConfigurationEntry
Record Components:
configurationBean - Class that defines this configuration entry
fieldName - java field name
type - Java type name, e.g. String or Integer.
configName - configuration property name, as written in the config file
defaultValue - default value declared in the java field, null if not defined
required - if the configuration property is mandatory (needs default or entry in the config file)
documentation - textual documentation of this configuration propery
public record ConfigurationEntry(Class<?> configurationBean, String fieldName, String type, String configName, @Nullable Object defaultValue, boolean required, String documentation) extends Record

  • Constructor Details

    • ConfigurationEntry

      public ConfigurationEntry(Class<?> configurationBean, String fieldName, String type, String configName, @Nullable Object defaultValue, boolean required, String documentation)
      Creates an instance of a ConfigurationEntry record class.
      Parameters:
      configurationBean - the value for the configurationBean record component
      fieldName - the value for the fieldName record component
      type - the value for the type record component
      configName - the value for the configName record component
      defaultValue - the value for the defaultValue record component
      required - the value for the required record component
      documentation - the value for the documentation record component

  • Method Details

    • hasPriority

      public boolean hasPriority()

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

    • configurationBean

      public Class<?> configurationBean()
      Returns the value of the configurationBean record component.
      Returns:
      the value of the configurationBean record component

    • fieldName

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

    • type

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

    • configName

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

    • defaultValue

      @Nullable public Object defaultValue()
      Returns the value of the defaultValue record component.
      Returns:
      the value of the defaultValue record component

    • required

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

    • documentation

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