Package net.okocraft.box.feature.gui.api.util

Record Class SoundBase

java.lang.Object
java.lang.Record
net.okocraft.box.feature.gui.api.util.SoundBase
public record SoundBase(@NotNull Sound sound) extends Record

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    SoundBase.Builder
     

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final SoundBase
    CLICK
     
    static final SoundBase
    UNSUCCESSFUL
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    SoundBase(@NotNull Sound sound)
    Creates an instance of a SoundBase record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static @NotNull SoundBase.Builder
    builder()
     
    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.
    void
    play(@NotNull org.bukkit.entity.Player target)
     
    @NotNull Sound
    sound()
    Returns the value of the sound record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • CLICK

      public static final SoundBase CLICK

    • UNSUCCESSFUL

      public static final SoundBase UNSUCCESSFUL

  • Constructor Details

    • SoundBase

      public SoundBase(@NotNull @NotNull Sound sound)
      Creates an instance of a SoundBase record class.
      Parameters:
      sound - the value for the sound record component

  • Method Details

    • builder

      @Contract(value=" -> new", pure=true) @NotNull public static @NotNull SoundBase.Builder builder()

    • play

      public void play(@NotNull @NotNull org.bukkit.entity.Player target)

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

    • sound

      @NotNull public @NotNull Sound sound()
      Returns the value of the sound record component.
      Returns:
      the value of the sound record component