Class RP_SYS_OverrideTracks

java.lang.Object

org.jjazz.rhythmmusicgeneration.api.RP_SYS_OverrideTracks

All Implemented Interfaces:

RhythmParameter<RP_SYS_OverrideTracksValue>

public class RP_SYS_OverrideTracks
extends Object
implements RhythmParameter<RP_SYS_OverrideTracksValue>

A RhythmParameter to override baseRhythm tracks by tracks from other rhythms.

Field Summary

Fields

Modifier and Type	Field	Description
static String	ID

Constructor Summary

Constructors

Constructor	Description
RP_SYS_OverrideTracks(Rhythm baseRhythm, boolean primary)

Method Summary

Modifier and Type	Method	Description
<T> RP_SYS_OverrideTracksValue	convertValue(RhythmParameter<T> rp, T rpValue)	Convert the value of a compatible RhythmParameter to a value for this RhythmParameter.
Rhythm	getBaseRhythm()
ConfigurableMusicGeneratorProvider	getConfigurableMusicGeneratorProvider()
RP_SYS_OverrideTracks	getCopy(Rhythm newBaseRhythm)	Get a copy of this RhythmParameter.
RP_SYS_OverrideTracksValue	getDefaultValue()
String	getDescription()	The description of this rhythm parameter.
String	getDisplayName()
String	getDisplayValue(RP_SYS_OverrideTracksValue value)	Get a short String representation of the value.
String	getId()
static RP_SYS_OverrideTracks	getOverrideTracksRp(Rhythm r)	Find the first RP_SYS_OverrideTracks instance in the baseRhythm parameters of r.
String	getValueDescription(RP_SYS_OverrideTracksValue value)	Provide an optional description or help text associated to the specified value.
boolean	isCompatibleWith(RhythmParameter<?> rp)	Indicate if rp is compatible with this RhythmParameter.
boolean	isPrimary()	Indicate if this RhythmParameter is a primary parameter for its rhythm.
boolean	isValidValue(RP_SYS_OverrideTracksValue value)
RP_SYS_OverrideTracksValue	loadFromString(String s)	Try to convert the specified string to a RhythmParameter value.
String	saveAsString(RP_SYS_OverrideTracksValue v)	Try to convert the specified RhythmParameter value to a string.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jjazz.rhythm.api.RhythmParameter

cloneValue

Field Details

ID

public static String ID

Constructor Details

RP_SYS_OverrideTracks

public RP_SYS_OverrideTracks(Rhythm baseRhythm,
 boolean primary)

Parameters:

baseRhythm - Must implement the ConfigurableMusicGeneratorProvider interface.

primary -

Method Details

getCopy

public RP_SYS_OverrideTracks getCopy(Rhythm newBaseRhythm)

Description copied from interface: RhythmParameter

Get a copy of this RhythmParameter.

Specified by:

getCopy in interface RhythmParameter<RP_SYS_OverrideTracksValue>

Parameters:

newBaseRhythm - Must implement the ConfigurableMusicGeneratorProvider interface.

Returns:

getConfigurableMusicGeneratorProvider

public ConfigurableMusicGeneratorProvider getConfigurableMusicGeneratorProvider()

getBaseRhythm

public Rhythm getBaseRhythm()

isPrimary

public boolean isPrimary()

Description copied from interface: RhythmParameter

Indicate if this RhythmParameter is a primary parameter for its rhythm.

This information is made available mainly for the user interface, e.g. to select which RhythmParameters to show first.

Default implementation returns true.

Specified by:

isPrimary in interface RhythmParameter<RP_SYS_OverrideTracksValue>

Returns:

getId

public String getId()

Specified by:

getId in interface RhythmParameter<RP_SYS_OverrideTracksValue>

Returns:

A unique identifier. Usually the english name.

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface RhythmParameter<RP_SYS_OverrideTracksValue>

Returns:

The localized display name of the rhythm parameter.

getDescription

public String getDescription()

Description copied from interface: RhythmParameter

The description of this rhythm parameter.

Specified by:

getDescription in interface RhythmParameter<RP_SYS_OverrideTracksValue>

Returns:

getValueDescription

public String getValueDescription(RP_SYS_OverrideTracksValue value)

Description copied from interface: RhythmParameter

Provide an optional description or help text associated to the specified value.

Specified by:

getValueDescription in interface RhythmParameter<RP_SYS_OverrideTracksValue>

Parameters:

value -

Returns:

Can be null.

getDefaultValue

public RP_SYS_OverrideTracksValue getDefaultValue()

Specified by:

getDefaultValue in interface RhythmParameter<RP_SYS_OverrideTracksValue>

Returns:

Object The default value.

saveAsString

public String saveAsString(RP_SYS_OverrideTracksValue v)

Description copied from interface: RhythmParameter

Try to convert the specified RhythmParameter value to a string.

Specified by:

saveAsString in interface RhythmParameter<RP_SYS_OverrideTracksValue>

Parameters:

v -

Returns:

Can be null if value is invalid.

See Also:

• RhythmParameter.loadFromString(java.lang.String)

loadFromString

public RP_SYS_OverrideTracksValue loadFromString(String s)

Description copied from interface: RhythmParameter

Try to convert the specified string to a RhythmParameter value.

Specified by:

loadFromString in interface RhythmParameter<RP_SYS_OverrideTracksValue>

Parameters:

s - A string produced by valueToString().

Returns:

Can be null if conversion failed.

See Also:

• RhythmParameter.saveAsString(E)

isValidValue

public boolean isValidValue(RP_SYS_OverrideTracksValue value)

Specified by:

isValidValue in interface RhythmParameter<RP_SYS_OverrideTracksValue>

Parameters:

value -

Returns:

True is value is valid.

toString

public String toString()

Overrides:

toString in class Object

isCompatibleWith

public boolean isCompatibleWith(RhythmParameter<?> rp)

Description copied from interface: RhythmParameter

Indicate if rp is compatible with this RhythmParameter.

NOTE: if rp1 is compatible with rp2, then rp2 must be compatible with rp1 as well.

Specified by:

isCompatibleWith in interface RhythmParameter<RP_SYS_OverrideTracksValue>

Parameters:

rp -

Returns:

True if a rp's value can be converted to a value for this RhythmParameter.

convertValue

public <T> RP_SYS_OverrideTracksValue convertValue(RhythmParameter<T> rp,
 T rpValue)

Description copied from interface: RhythmParameter

Convert the value of a compatible RhythmParameter to a value for this RhythmParameter.

Specified by:

convertValue in interface RhythmParameter<RP_SYS_OverrideTracksValue>

Type Parameters:

T - A RhythmParameter value

Parameters:

rp - A compatible RhythmParameter

rpValue - The value to convert

Returns:

The rpValue converted for this RhythmParameter. Can't be null.

getDisplayValue

public String getDisplayValue(RP_SYS_OverrideTracksValue value)

Description copied from interface: RhythmParameter

Get a short String representation of the value.

Specified by:

getDisplayValue in interface RhythmParameter<RP_SYS_OverrideTracksValue>

Parameters:

value -

Returns:

Can be an empty String.

getOverrideTracksRp

public static RP_SYS_OverrideTracks getOverrideTracksRp(Rhythm r)

Find the first RP_SYS_OverrideTracks instance in the baseRhythm parameters of r.

Parameters:

r -

Returns:

Can be null if not found