Record Class ConfigReaderSpigot

java.lang.Object
java.lang.Record
nl.pim16aap2.animatedarchitecture.spigot.util.implementations.ConfigReaderSpigot
All Implemented Interfaces:
IConfigReader
public record ConfigReaderSpigot(org.bukkit.configuration.file.FileConfiguration config) extends Record implements IConfigReader
Spigot implementation for IConfigReader.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ConfigReaderSpigot(org.bukkit.configuration.file.FileConfiguration config)
    Creates an instance of a ConfigReaderSpigot record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.bukkit.configuration.file.FileConfiguration
    config()
    Returns the value of the config record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    @Nullable Object
    get(String path, @Nullable Object fallback)
    Gets the value of a config option at a given path.
    Set<String>
    getKeys()
    Gets a set containing all keys.
    final int
    hashCode()
    Returns a hash code value for this object.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

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

  • Constructor Details

    • ConfigReaderSpigot

      public ConfigReaderSpigot(org.bukkit.configuration.file.FileConfiguration config)
      Creates an instance of a ConfigReaderSpigot record class.
      Parameters:
      config - the value for the config record component

  • Method Details

    • get

      public @Nullable Object get(String path, @Nullable Object fallback)
      Description copied from interface: IConfigReader
      Gets the value of a config option at a given path. If unavailable, the default object is returned instead.
      Specified by:
      get in interface IConfigReader
      Parameters:
      path - The path of the config option to read.
      fallback - The default value to return if the actual option in the config was unavailable.
      Returns:
      The value of the config option if possible, otherwise the default value.

    • getKeys

      public Set<String> getKeys()
      Description copied from interface: IConfigReader
      Gets a set containing all keys.
      Specified by:
      getKeys in interface IConfigReader

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

    • config

      public org.bukkit.configuration.file.FileConfiguration config()
      Returns the value of the config record component.
      Returns:
      the value of the config record component