Package org.jjazz.rhythm.api.rhythmparameters

Class RP_SYS_CustomPhrase

java.lang.Object

org.jjazz.rhythm.api.rhythmparameters.RP_SYS_CustomPhrase

All Implemented Interfaces:

RhythmParameter<RP_SYS_CustomPhraseValue>

public class RP_SYS_CustomPhrase
extends Object
implements RhythmParameter<RP_SYS_CustomPhraseValue>

A RhythmParameter to replace one or more generated Phrases by custom Phrases.

Constructor Summary

Constructors

Constructor	Description
RP_SYS_CustomPhrase(Rhythm r, boolean primary)

Method Summary

Modifier and Type	Method	Description
RP_SYS_CustomPhraseValue	cloneValue(RP_SYS_CustomPhraseValue value)	Clone the specified value.
<T> RP_SYS_CustomPhraseValue	convertValue(RhythmParameter<T> rp, T value)	Reuse a custom phrase when there is a matching RhythmVoice (same type).
static RP_SYS_CustomPhrase	getCustomPhraseRp(Rhythm rhythm)	Find the first RP_SYS_CustomPhrase instance in the rhythm parameters of r.
RP_SYS_CustomPhraseValue	getDefaultValue()
String	getDescription()	The description of this rhythm parameter.
String	getDisplayName()
String	getDisplayValue(RP_SYS_CustomPhraseValue value)	Get a short String representation of the value.
String	getId()
Rhythm	getRhythm()	The rhythm associated to this RhythmParameter.
String	getValueDescription(RP_SYS_CustomPhraseValue value)	Provide an optional description or help text associated to the specified value.
boolean	isCompatibleWith(RhythmParameter<?> rp)	Compatible with another RP_SYS_CustomPhrase for the same rhythm time signature.
boolean	isPrimary()	Indicate if this RhythmParameter is a primary parameter for its rhythm.
boolean	isValidValue(RP_SYS_CustomPhraseValue value)
RP_SYS_CustomPhraseValue	loadFromString(String s)	Try to convert the specified string to a RhythmParameter value.
String	saveAsString(RP_SYS_CustomPhraseValue 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

Constructor Details

RP_SYS_CustomPhrase

public RP_SYS_CustomPhrase(Rhythm r,
 boolean primary)

Method Details

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_CustomPhraseValue>

Returns:

getRhythm

public Rhythm getRhythm()

The rhythm associated to this RhythmParameter.

Returns:

getId

public String getId()

Specified by:

getId in interface RhythmParameter<RP_SYS_CustomPhraseValue>

Returns:

A unique identifier. Usually the english name.

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface RhythmParameter<RP_SYS_CustomPhraseValue>

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_CustomPhraseValue>

Returns:

getValueDescription

public String getValueDescription(RP_SYS_CustomPhraseValue 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_CustomPhraseValue>

Returns:

Can be null.

getDefaultValue

public RP_SYS_CustomPhraseValue getDefaultValue()

Specified by:

getDefaultValue in interface RhythmParameter<RP_SYS_CustomPhraseValue>

Returns:

Object The default value.

saveAsString

public String saveAsString(RP_SYS_CustomPhraseValue v)

Description copied from interface: RhythmParameter

Try to convert the specified RhythmParameter value to a string.

Specified by:

saveAsString in interface RhythmParameter<RP_SYS_CustomPhraseValue>

Returns:

Can be null if value is invalid or RhytmParameter does not have this capability.

See Also:

• RhythmParameter.loadFromString(java.lang.String)

loadFromString

public RP_SYS_CustomPhraseValue 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_CustomPhraseValue>

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_CustomPhraseValue value)

Specified by:

isValidValue in interface RhythmParameter<RP_SYS_CustomPhraseValue>

Returns:

True is value is valid.

cloneValue

public RP_SYS_CustomPhraseValue cloneValue(RP_SYS_CustomPhraseValue value)

Description copied from interface: RhythmParameter

Clone the specified value.

The default implementation just return value, which is fine is E is an immutable class. If E is mutable, this method must be overridden.

Specified by:

cloneValue in interface RhythmParameter<RP_SYS_CustomPhraseValue>

Returns:

A copy of the specified value.

isCompatibleWith

public boolean isCompatibleWith(RhythmParameter<?> rp)

Compatible with another RP_SYS_CustomPhrase for the same rhythm time signature.

Specified by:

isCompatibleWith in interface RhythmParameter<RP_SYS_CustomPhraseValue>

Parameters:

rp -

Returns:

convertValue

public <T> RP_SYS_CustomPhraseValue convertValue(RhythmParameter<T> rp,
 T value)

Reuse a custom phrase when there is a matching RhythmVoice (same type).

Specified by:

convertValue in interface RhythmParameter<RP_SYS_CustomPhraseValue>

Type Parameters:

T -

Parameters:

rp -

value -

Returns:

getDisplayValue

public String getDisplayValue(RP_SYS_CustomPhraseValue value)

Description copied from interface: RhythmParameter

Get a short String representation of the value.

Specified by:

getDisplayValue in interface RhythmParameter<RP_SYS_CustomPhraseValue>

Returns:

Can be an empty String.

toString

public String toString()

Overrides:

toString in class Object

getCustomPhraseRp

public static RP_SYS_CustomPhrase getCustomPhraseRp(Rhythm rhythm)

Find the first RP_SYS_CustomPhrase instance in the rhythm parameters of r.

Parameters:

rhythm -

Returns:

Can be null if not found