Record Class AudioDescription

java.lang.Object
java.lang.Record
nl.pim16aap2.animatedarchitecture.core.audio.AudioDescription
Record Components:
sound - The name of the sound to play.
volume - The volume at which to play the sound.
pitch - The pitch of the sound.
duration - The duration of the sound (in milliseconds).
public record AudioDescription(String sound, float volume, float pitch, int duration) extends Record
Describes a sound, with its pitch and volume etc.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    AudioDescription.Deserializer
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    AudioDescription(String sound, float volume, float pitch, int duration)
    Creates an instance of a AudioDescription record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    duration()
    Returns the value of the duration 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.
    float
    pitch()
    Returns the value of the pitch record component.
    String
    sound()
    Returns the value of the sound 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 Object

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

  • Constructor Details

    • AudioDescription

      public AudioDescription(String sound, float volume, float pitch, int duration)
      Creates an instance of a AudioDescription record class.
      Parameters:
      sound - the value for the sound record component
      volume - the value for the volume record component
      pitch - the value for the pitch record component
      duration - the value for the duration 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 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.

    • sound

      public String sound()
      Returns the value of the sound record component.
      Returns:
      the value of the sound 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

    • duration

      public int duration()
      Returns the value of the duration record component.
      Returns:
      the value of the duration record component