Class RP_SYS_OverrideTracksValue

java.lang.Object

org.jjazz.rhythmmusicgeneration.api.RP_SYS_OverrideTracksValue

public class RP_SYS_OverrideTracksValue
extends Object

Store which source RhythmVoice is overridden by which [RhythmVoice-rhythm variation] pair.

This is an immutable value.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	RP_SYS_OverrideTracksValue.Override

Constructor Summary

Constructors

Constructor	Description
RP_SYS_OverrideTracksValue(Rhythm baseRhythm)	Create a value with no override.
RP_SYS_OverrideTracksValue(Rhythm baseRhythm, Map<RhythmVoice,RP_SYS_OverrideTracksValue.Override> mappings)	Create the value for baseRhythm with the specified mappings.

Method Summary

Modifier and Type	Method	Description
RP_SYS_OverrideTracksValue	clone()
Set<Rhythm>	getAllDestinationRhythms()	Get all the destination rhythms used in the mappings.
Set<RhythmVoice>	getAllSourceRhythmVoices()	Get all the source RhythmVoices mapped to other RhythmVoices.
Rhythm	getBaseRhythm()
RP_SYS_OverrideTracksValue.Override	getOverride(RhythmVoice rvSrc)	The destination RhythmVoice and variation for rvSrc.
boolean	isEmpty()	If true no RhythmVoice mapping is set.
static RP_SYS_OverrideTracksValue	loadFromString(Rhythm baseRhythm, String s)	Create an object from a string.
static String	saveAsString(RP_SYS_OverrideTracksValue v)	Save the specified object state as a string.
RP_SYS_OverrideTracksValue	set(RhythmVoice rvSrc, RP_SYS_OverrideTracksValue.Override override)	Return a new RP_SYS_OverrideTracksValue cloned from this instance but with the rvSrc-Override mapping changed.
String	toDescriptionString()
String	toString()
static String	toString(RhythmVoice rvSrc, RP_SYS_OverrideTracksValue.Override override)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

RP_SYS_OverrideTracksValue

public RP_SYS_OverrideTracksValue(Rhythm baseRhythm)

Create a value with no override.

Parameters:

baseRhythm - Must implement the ConfigurableMusicGeneratorProvider interface

RP_SYS_OverrideTracksValue

public RP_SYS_OverrideTracksValue(Rhythm baseRhythm,
 Map<RhythmVoice,RP_SYS_OverrideTracksValue.Override> mappings)

Create the value for baseRhythm with the specified mappings.

Parameters:

baseRhythm - Must implement the ConfigurableMusicGeneratorProvider interface

mappings - All RhythmVoice keys must belong to baseRhythm. Override can not be null.

Method Details

set

public RP_SYS_OverrideTracksValue set(RhythmVoice rvSrc,
 RP_SYS_OverrideTracksValue.Override override)

Return a new RP_SYS_OverrideTracksValue cloned from this instance but with the rvSrc-Override mapping changed.

Parameters:

rvSrc - Must belong to the baseRhythm

override - Can be null to remove the mapping for rvSrc

Returns:

getBaseRhythm

public Rhythm getBaseRhythm()

getAllDestinationRhythms

public Set<Rhythm> getAllDestinationRhythms()

Get all the destination rhythms used in the mappings.

Returns:

isEmpty

public boolean isEmpty()

If true no RhythmVoice mapping is set.

Returns:

clone

public RP_SYS_OverrideTracksValue clone()

getAllSourceRhythmVoices

public Set<RhythmVoice> getAllSourceRhythmVoices()

Get all the source RhythmVoices mapped to other RhythmVoices.

Returns:

getOverride

public RP_SYS_OverrideTracksValue.Override getOverride(RhythmVoice rvSrc)

The destination RhythmVoice and variation for rvSrc.

Parameters:

rvSrc -

Returns:

Can be null if not mapped

toDescriptionString

public String toDescriptionString()

toString

public static String toString(RhythmVoice rvSrc,
 RP_SYS_OverrideTracksValue.Override override)

saveAsString

public static String saveAsString(RP_SYS_OverrideTracksValue v)

Save the specified object state as a string.

"Phrase1>>jjSwing-ID>>Bass>>Main B-1 && Chord1>>popRock-ID>>Chord1" means :
- base rhythm voice Phrase1 is mapped to jjSwing/Bass rhythm voice with variation Main B-1
- base rhythm voice Chord1 is mapped to popRock/Chord1 rhythm voice with no dest. variation specified.

Parameters:

v -

Returns:

See Also:

• loadFromString(org.jjazz.rhythm.api.Rhythm, java.lang.String)

loadFromString

public static RP_SYS_OverrideTracksValue loadFromString(Rhythm baseRhythm,
 String s)

Create an object from a string.

Parameters:

baseRhythm -

s -

Returns:

Can not be null. If an error occured, returns the default value

See Also:

• saveAsString(org.jjazz.rhythmmusicgeneration.api.RP_SYS_OverrideTracksValue)

toString

public String toString()

Overrides:

toString in class Object