Record Class RhythmInfo.RvInfo

java.lang.Object

java.lang.Record

org.jjazz.rhythmdatabase.api.RhythmInfo.RvInfo

Record Components:

gmSubstitute - Can be null

drumKit - Can be null

All Implemented Interfaces:

Serializable

Enclosing class:

RhythmInfo

public static record RhythmInfo.RvInfo(String name, GM1Instrument gmSubstitute, int preferredChannel, DrumKit drumKit, RhythmVoice.Type type)
extends Record
implements Serializable

A RhythmVoice descriptor.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
RvInfo(String name, GM1Instrument gmSubstitute, int preferredChannel, DrumKit drumKit, RhythmVoice.Type type)	Creates an instance of a RvInfo record class.
RvInfo(RhythmVoice rv)

Method Summary

Modifier and Type	Method	Description
DrumKit	drumKit()	Returns the value of the drumKit record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
GM1Instrument	gmSubstitute()	Returns the value of the gmSubstitute record component.
final int	hashCode()	Returns a hash code value for this object.
String	name()	Returns the value of the name record component.
int	preferredChannel()	Returns the value of the preferredChannel record component.
final String	toString()	Returns a string representation of this record class.
RhythmVoice.Type	type()	Returns the value of the type record component.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

RvInfo

public RvInfo(RhythmVoice rv)

RvInfo

public RvInfo(String name,
 GM1Instrument gmSubstitute,
 int preferredChannel,
 DrumKit drumKit,
 RhythmVoice.Type type)

Creates an instance of a RvInfo record class.

Parameters:

name - the value for the name record component

gmSubstitute - the value for the gmSubstitute record component

preferredChannel - the value for the preferredChannel record component

drumKit - the value for the drumKit record component

type - the value for the type 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.

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

gmSubstitute

public GM1Instrument gmSubstitute()

Returns the value of the gmSubstitute record component.

Returns:

the value of the gmSubstitute record component

preferredChannel

public int preferredChannel()

Returns the value of the preferredChannel record component.

Returns:

the value of the preferredChannel record component

drumKit

public DrumKit drumKit()

Returns the value of the drumKit record component.

Returns:

the value of the drumKit record component

type

public RhythmVoice.Type type()

Returns the value of the type record component.

Returns:

the value of the type record component