Record Class ModuleConfig

java.lang.Object
java.lang.Record
kr.toxicity.model.api.config.ModuleConfig
Record Components:
model - creates model
playerAnimation - create player animation
public record ModuleConfig(boolean model, boolean playerAnimation) extends Record
Module config

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final ModuleConfig
    DEFAULT
    Default config

  • Constructor Summary

    Constructors
    Constructor
    Description
    ModuleConfig(boolean model, boolean playerAnimation)
    Creates an instance of a ModuleConfig record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    static @NotNull ModuleConfig
    from(@NotNull Predicate<String> predicate)
    Creates config from YAML
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    model()
    Returns the value of the model record component.
    boolean
    playerAnimation()
    Returns the value of the playerAnimation record component.
    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

    • DEFAULT

      public static final ModuleConfig DEFAULT
      Default config

  • Constructor Details

    • ModuleConfig

      public ModuleConfig(boolean model, boolean playerAnimation)
      Creates an instance of a ModuleConfig record class.
      Parameters:
      model - the value for the model record component
      playerAnimation - the value for the playerAnimation record component

  • Method Details

    • from

      @NotNull public static @NotNull ModuleConfig from(@NotNull @NotNull Predicate<String> predicate)
      Creates config from YAML
      Parameters:
      predicate - predicate
      Returns:
      config

    • 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 the compare method from their corresponding wrapper classes.
      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.

    • model

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

    • playerAnimation

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