Class RhythmStub

java.lang.Object

org.jjazz.rhythmstubs.api.RhythmStub

All Implemented Interfaces:

Comparable<Rhythm>, Rhythm, MusicGeneratorProvider

public class RhythmStub
extends Object
implements Rhythm, MusicGeneratorProvider

A rhythm stub whatever the time signature.

Field Summary

Fields inherited from interface org.jjazz.rhythm.api.Rhythm

PROP_RESOURCES_LOADED

Constructor Summary

Constructors

Constructor	Description
RhythmStub(String uniqueId, TimeSignature ts)	Create a dummy rhythm for specified time signature.

Method Summary

Modifier and Type	Method	Description
void	addPropertyChangeListener(PropertyChangeListener l)
int	compareTo(Rhythm o)	Compare alphabetically on the rhythm's name.
boolean	equals(Object o)
String	getAuthor()
String	getDescription()
RhythmFeatures	getFeatures()	The general features of this rhythm.
File	getFile()	Optional file from which this rhythm was loaded.
MusicGenerator	getMusicGenerator()
String	getName()
int	getPreferredTempo()
List<RhythmParameter<?>>	getRhythmParameters()
List<RhythmVoice>	getRhythmVoices()
String[]	getTags()	Can be any keyword strings used to describe the rhythm.
TimeSignature	getTimeSignature()
String	getUniqueId()	A unique string identifier representing this rhythm.
int	hashCode()
boolean	isResourcesLoaded()
void	loadResources()	Tell the rhythm it may load any memory-heavy resources.
void	releaseResources()	This implementation does nothing.
void	removePropertyChangeListener(PropertyChangeListener l)
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

getVersion

Constructor Details

RhythmStub

public RhythmStub(String uniqueId,
 TimeSignature ts)

Create a dummy rhythm for specified time signature.

Parameters:

uniqueId -

ts -

Method Details

getMusicGenerator

public MusicGenerator getMusicGenerator()

Specified by:

getMusicGenerator in interface MusicGeneratorProvider

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getRhythmVoices

public List<RhythmVoice> getRhythmVoices()

Specified by:

getRhythmVoices in interface Rhythm

Returns:

The voices for which this rhythm can generate music. Each voice must have a unique name.

getRhythmParameters

public List<RhythmParameter<?>> getRhythmParameters()

Specified by:

getRhythmParameters in interface Rhythm

Returns:

The RhythmParameters that influence the way this rhythm generates music.

getTimeSignature

public TimeSignature getTimeSignature()

Specified by:

getTimeSignature in interface Rhythm

loadResources

public void loadResources()

Description copied from interface: Rhythm

Tell the rhythm it may load any memory-heavy resources.

This will fire a PROP_RESOURCES_LOADED change event with newValue=true.

Specified by:

loadResources in interface Rhythm

See Also:

• Rhythm.releaseResources()

isResourcesLoaded

public boolean isResourcesLoaded()

Specified by:

isResourcesLoaded in interface Rhythm

Returns:

true

releaseResources

public void releaseResources()

This implementation does nothing.

Specified by:

releaseResources in interface Rhythm

See Also:

• Rhythm.loadResources()

compareTo

public int compareTo(Rhythm o)

Description copied from interface: Rhythm

Compare alphabetically on the rhythm's name.

Specified by:

compareTo in interface Comparable<Rhythm>

Specified by:

compareTo in interface Rhythm

Parameters:

o -

Returns:

getFile

public File getFile()

Description copied from interface: Rhythm

Optional file from which this rhythm was loaded.

Specified by:

getFile in interface Rhythm

Returns:

Can't be null, but can be an empty path ("") if no file associated.

getFeatures

public RhythmFeatures getFeatures()

Description copied from interface: Rhythm

The general features of this rhythm.

Specified by:

getFeatures in interface Rhythm

Returns:

getUniqueId

public String getUniqueId()

Description copied from interface: Rhythm

A unique string identifier representing this rhythm.

It will be used by other serialized objects who want to refer this rhythm -typically a Song object.

Specified by:

getUniqueId in interface Rhythm

Returns:

A non-empty String with spaces trimmed.

getDescription

public String getDescription()

Specified by:

getDescription in interface Rhythm

getPreferredTempo

public int getPreferredTempo()

Specified by:

getPreferredTempo in interface Rhythm

getName

public String getName()

Specified by:

getName in interface Rhythm

getAuthor

public String getAuthor()

Specified by:

getAuthor in interface Rhythm

getTags

public String[] getTags()

Description copied from interface: Rhythm

Can be any keyword strings used to describe the rhythm.

Specified by:

getTags in interface Rhythm

Returns:

Default to an empty array.

toString

public String toString()

Overrides:

toString in class Object

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener l)

Specified by:

addPropertyChangeListener in interface Rhythm

Parameters:

l -

See Also:

• Rhythm.loadResources()
• Rhythm.releaseResources()

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener l)

Specified by:

removePropertyChangeListener in interface Rhythm

Parameters:

l -

See Also:

• Rhythm.loadResources()
• Rhythm.releaseResources()