Record Class SongPartParameter

java.lang.Object
java.lang.Record
org.jjazz.songstructure.api.SongPartParameter
public record SongPartParameter(SongPart spt, RhythmParameter<?> rp) extends Record
Store a RP and its associated SongPart.

  • Constructor Summary

    Constructors
    Constructor
    Description
    SongPartParameter(SongPart spt, RhythmParameter<?> rp)
    Creates an instance of a SongPartParameter record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    int
    hashCode()
    Returns a hash code value for this object.
    boolean
    isEnumerableRp()
    True if the RhythmParameter is an instance of RP_Enumerable.
    RhythmParameter<?>
    rp()
    Returns the value of the rp record component.
    SongPart
    spt()
    Returns the value of the spt record component.
    String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • SongPartParameter

      public SongPartParameter(SongPart spt, RhythmParameter<?> rp)
      Creates an instance of a SongPartParameter record class.
      Parameters:
      spt - the value for the spt record component
      rp - the value for the rp record component

  • Method Details

    • isEnumerableRp

      public boolean isEnumerableRp()
      True if the RhythmParameter is an instance of RP_Enumerable.
      Returns:

    • equals

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

    • hashCode

      public 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

    • toString

      public 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

    • spt

      public SongPart spt()
      Returns the value of the spt record component.
      Returns:
      the value of the spt record component

    • rp

      public RhythmParameter<?> rp()
      Returns the value of the rp record component.
      Returns:
      the value of the rp record component