Record Class MusicGenerationQueue.Result

java.lang.Object

java.lang.Record

org.jjazz.musiccontrol.api.MusicGenerationQueue.Result

Record Components:

songContext -

mapRvPhrases -

throwable - If not null an unexpected problem occured.

Enclosing class:

MusicGenerationQueue

public static record MusicGenerationQueue.Result(SongContext songContext, Map<RhythmVoice,Phrase> mapRvPhrases, Throwable throwable)
extends Record

A result from a music generation.

Constructor Summary

Constructors

Constructor	Description
Result(SongContext songContext, Map<RhythmVoice,Phrase> mapRvPhrases, Throwable throwable)	Creates an instance of a Result record class.

Method Summary

Modifier and Type	Method	Description
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.
Map<RhythmVoice,Phrase>	mapRvPhrases()	Returns the value of the mapRvPhrases record component.
SongContext	songContext()	Returns the value of the songContext record component.
Throwable	throwable()	Returns the value of the throwable record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Result

public Result(SongContext songContext,
 Map<RhythmVoice,Phrase> mapRvPhrases,
 Throwable throwable)

Creates an instance of a Result record class.

Parameters:

songContext - the value for the songContext record component

mapRvPhrases - the value for the mapRvPhrases record component

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

songContext

public SongContext songContext()

Returns the value of the songContext record component.

Returns:

the value of the songContext record component

mapRvPhrases

public Map<RhythmVoice,Phrase> mapRvPhrases()

Returns the value of the mapRvPhrases record component.

Returns:

the value of the mapRvPhrases record component

throwable

public Throwable throwable()

Returns the value of the throwable record component.

Returns:

the value of the throwable record component