Package com.winterhavenmc.library.messagebuilder.models.sound

Record Class ValidSoundRecord

java.lang.Object
java.lang.Record
com.winterhavenmc.library.messagebuilder.models.sound.ValidSoundRecord
Record Components:
key - Section the key for the sound entry
enabled - boolean if the sound entry is enabled for playback
playerOnly - boolean if the sound entry should be played for an individual or for a location
soundName - Section the bukkit Sound constant name, formerly an enum but now contained in the bukkit registry
volume - float the volume of playback for the sound entry
pitch - float the pitch of playback for the sound entry
All Implemented Interfaces:
SoundRecord
public record ValidSoundRecord(String key, boolean enabled, boolean playerOnly, String soundName, float volume, float pitch) extends Record implements SoundRecord
A class that contains the key and fields of a sound entry in the sound configuration

  • Constructor Summary

    Constructors
    Constructor
    Description
    ValidSoundRecord(String key, boolean enabled, boolean playerOnly, String soundName, float volume, float pitch)
    Creates an instance of a ValidSoundRecord record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    enabled()
    Returns the value of the enabled 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.
    String
    key()
    Returns the value of the key record component.
    float
    pitch()
    Returns the value of the pitch record component.
    boolean
    playerOnly()
    Returns the value of the playerOnly record component.
    String
    soundName()
    Returns the value of the soundName record component.
    final String
    toString()
    Returns a string representation of this record class.
    float
    volume()
    Returns the value of the volume record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ValidSoundRecord

      public ValidSoundRecord(String key, boolean enabled, boolean playerOnly, String soundName, float volume, float pitch)
      Creates an instance of a ValidSoundRecord record class.
      Parameters:
      key - the value for the key record component
      enabled - the value for the enabled record component
      playerOnly - the value for the playerOnly record component
      soundName - the value for the soundName record component
      volume - the value for the volume record component
      pitch - the value for the pitch 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.

    • key

      public String key()
      Returns the value of the key record component.
      Specified by:
      key in interface SoundRecord
      Returns:
      the value of the key record component

    • enabled

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

    • playerOnly

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

    • soundName

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

    • volume

      public float volume()
      Returns the value of the volume record component.
      Returns:
      the value of the volume record component

    • pitch

      public float pitch()
      Returns the value of the pitch record component.
      Returns:
      the value of the pitch record component