Record Class LoadedConfig

java.lang.Object
java.lang.Record
net.neoforged.fml.config.LoadedConfig
All Implemented Interfaces:
IConfigSpec.ILoadedConfig
record LoadedConfig(com.electronwill.nightconfig.core.CommentedConfig config, @Nullable Path path, ModConfig modConfig) extends Record implements IConfigSpec.ILoadedConfig

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final com.electronwill.nightconfig.core.CommentedConfig
    config
    The field for the config record component.
    private final ModConfig
    modConfig
    The field for the modConfig record component.
    private final @Nullable Path
    path
    The field for the path record component.

  • Constructor Summary

    Constructors
    Constructor
    Description
    LoadedConfig(com.electronwill.nightconfig.core.CommentedConfig config, @Nullable Path path, ModConfig modConfig)
    Creates an instance of a LoadedConfig record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.electronwill.nightconfig.core.CommentedConfig
    config()
    Returns the value of the config record component.
    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.
    ModConfig
    modConfig()
    Returns the value of the modConfig record component.
    @Nullable Path
    path()
    Returns the value of the path record component.
    void
    save()
    Saves the current value of the IConfigSpec.ILoadedConfig.config() and dispatches a config reloading event.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

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

  • Field Details

    • config

      private final com.electronwill.nightconfig.core.CommentedConfig config
      The field for the config record component.

    • path

      @Nullable private final @Nullable Path path
      The field for the path record component.

    • modConfig

      private final ModConfig modConfig
      The field for the modConfig record component.

  • Constructor Details

    • LoadedConfig

      LoadedConfig(com.electronwill.nightconfig.core.CommentedConfig config, @Nullable @Nullable Path path, ModConfig modConfig)
      Creates an instance of a LoadedConfig record class.
      Parameters:
      config - the value for the config record component
      path - the value for the path record component
      modConfig - the value for the modConfig record component

  • Method Details

    • save

      public void save()
      Description copied from interface: IConfigSpec.ILoadedConfig
      Saves the current value of the IConfigSpec.ILoadedConfig.config() and dispatches a config reloading event.
      Specified by:
      save in interface IConfigSpec.ILoadedConfig

    • 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 com.electronwill.nightconfig.core.CommentedConfig config()
      Returns the value of the config record component.
      Specified by:
      config in interface IConfigSpec.ILoadedConfig
      Returns:
      the value of the config record component

    • path

      @Nullable public @Nullable Path path()
      Returns the value of the path record component.
      Returns:
      the value of the path record component

    • modConfig

      public ModConfig modConfig()
      Returns the value of the modConfig record component.
      Returns:
      the value of the modConfig record component