Package org.jjazz.rhythm.api

Class RP_StringSet

java.lang.Object

org.jjazz.rhythm.api.RP_StringSet

All Implemented Interfaces:

RhythmParameter<Set<String>>, RpEnumerable<Set<String>>

Direct Known Subclasses:

RP_SYS_Mute

public class RP_StringSet
extends Object
implements RhythmParameter<Set<String>>, RpEnumerable<Set<String>>

A RhythmParameter composed of a set of strings.

All Set instances returned are immutable.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_SET_SIZE

Constructor Summary

Constructors

Constructor	Description
RP_StringSet(String id, String name, String description, boolean isPrimary, Set<String> defaultValue, String... possibleValues)	Create a RP_StringSet.

Method Summary

Modifier and Type	Method	Description
final double	calculatePercentage(Set<String> value)	A unique value for a set.
final Set<String>	calculateValue(double p)	Calculate a Set from p as produced by calculatePercentage().
<T> Set<String>	convertValue(RhythmParameter<T> rp, T value)	Convert the value of a compatible RhythmParameter to a value for this RhythmParameter.
boolean	equals(Object obj)
final Set<String>	getDefaultValue()
final String	getDescription()	The description of this rhythm parameter.
final String	getDisplayName()
String	getDisplayValue(Set<String> value)	Get a short String representation of the value.
final String	getId()
final Set<String>	getMaxValue()
final Set<String>	getMinValue()
final Set<String>	getNextValue(Set<String> value)	Get the next value after specified value.
final List<Set<String>>	getPossibleValues()	Return a single-element list containing one set with all possible values.
final Set<String>	getPreviousValue(Set<String> value)	Get the next value before specified value.
String	getValueDescription(Set<String> value)	Provide an optional description or help text associated to the specified value.
int	hashCode()
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.
final boolean	isValidValue(Set<String> value)	True if all elements of value are one of the possible values, or if value is empty.
Set<String>	loadFromString(String s)	Try to convert the specified string to a RhythmParameter value.
String	saveAsString(Set<String> value)	Try to convert the specified RhythmParameter value to a string.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

cloneValue

Field Details

MAX_SET_SIZE

public static final int MAX_SET_SIZE

See Also:

• Constant Field Values

Constructor Details

RP_StringSet

public RP_StringSet(String id,
 String name,
 String description,
 boolean isPrimary,
 Set<String> defaultValue,
 String... possibleValues)

Create a RP_StringSet.

Created instance is primary by default.

Parameters:

id -

name - The name of the RhythmParameter.

description -

isPrimary -

defaultValue - All members of the Set must be one of the possibleValues

possibleValues - String[] The possible values which can be used in a Set (max MAX_SET_SIZE). By convention, min value is set to the 1st possible value, max value to the last one. The empty string must not be one of the possible values.

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<Set<String>>

Returns:

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getId

public final String getId()

Specified by:

getId in interface RhythmParameter<Set<String>>

Returns:

A unique identifier. Usually the english name.

getDefaultValue

public final Set<String> getDefaultValue()

Specified by:

getDefaultValue in interface RhythmParameter<Set<String>>

Returns:

Object The default value.

isValidValue

public final boolean isValidValue(Set<String> value)

True if all elements of value are one of the possible values, or if value is empty.

Specified by:

isValidValue in interface RhythmParameter<Set<String>>

Parameters:

value -

Returns:

calculateValue

public final Set<String> calculateValue(double p)

Calculate a Set from p as produced by calculatePercentage().

Specified by:

calculateValue in interface RpEnumerable<Set<String>>

Parameters:

p - [0-1]

Returns:

calculatePercentage

public final double calculatePercentage(Set<String> value)

A unique value for a set.

1/ Construct and int value : each bit correspond to the presence of not of the possibleValues.
2/ Divide this value by 10000 to make sure it's between 0 and 1.

Specified by:

calculatePercentage in interface RpEnumerable<Set<String>>

Returns:

[0-1]

getDescription

public final String getDescription()

Description copied from interface: RhythmParameter

The description of this rhythm parameter.

Specified by:

getDescription in interface RhythmParameter<Set<String>>

Returns:

getMaxValue

public final Set<String> getMaxValue()

Specified by:

getMaxValue in interface RpEnumerable<Set<String>>

Returns:

A set with all the possible items.

getMinValue

public final Set<String> getMinValue()

Specified by:

getMinValue in interface RpEnumerable<Set<String>>

Returns:

An empty set.

getDisplayName

public final String getDisplayName()

Specified by:

getDisplayName in interface RhythmParameter<Set<String>>

Returns:

The localized display name of the rhythm parameter.

getNextValue

public final Set<String> getNextValue(Set<String> value)

Description copied from interface: RpEnumerable

Get the next value after specified value.

Specified by:

getNextValue in interface RpEnumerable<Set<String>>

Returns:

Object

getPreviousValue

public final Set<String> getPreviousValue(Set<String> value)

Description copied from interface: RpEnumerable

Get the next value before specified value.

Specified by:

getPreviousValue in interface RpEnumerable<Set<String>>

Returns:

Object

getPossibleValues

public final List<Set<String>> getPossibleValues()

Return a single-element list containing one set with all possible values.

Note: this does not return all the possible combinations of the set.

Specified by:

getPossibleValues in interface RpEnumerable<Set<String>>

Returns:

saveAsString

public String saveAsString(Set<String> value)

Description copied from interface: RhythmParameter

Try to convert the specified RhythmParameter value to a string.

Specified by:

saveAsString in interface RhythmParameter<Set<String>>

Parameters:

value -

Returns:

A string with format "[v1,v2,v5]"

See Also:

• RhythmParameter.loadFromString(java.lang.String)

loadFromString

public Set<String> loadFromString(String s)

Description copied from interface: RhythmParameter

Try to convert the specified string to a RhythmParameter value.

Specified by:

loadFromString in interface RhythmParameter<Set<String>>

Parameters:

s - A string produced by valueToString().

Returns:

Can be null if conversion failed.

See Also:

• RhythmParameter.saveAsString(E)

getValueDescription

public String getValueDescription(Set<String> value)

Description copied from interface: RhythmParameter

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

Specified by:

getValueDescription in interface RhythmParameter<Set<String>>

Returns:

Can be null.

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<Set<String>>

Returns:

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

convertValue

public <T> Set<String> convertValue(RhythmParameter<T> rp,
 T value)

Description copied from interface: RhythmParameter

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

Specified by:

convertValue in interface RhythmParameter<Set<String>>

Type Parameters:

T - A RhythmParameter value

Parameters:

rp - A compatible RhythmParameter

value - The value to convert

Returns:

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

getDisplayValue

public String getDisplayValue(Set<String> value)

Description copied from interface: RhythmParameter

Get a short String representation of the value.

Specified by:

getDisplayValue in interface RhythmParameter<Set<String>>

Returns:

Can be an empty String.