Package org.jjazz.rhythm.api

Enum Class RhythmVoice.Type

java.lang.Object

java.lang.Enum<RhythmVoice.Type>

org.jjazz.rhythm.api.RhythmVoice.Type

All Implemented Interfaces:

Serializable, Comparable<RhythmVoice.Type>, Constable

Enclosing class:

RhythmVoice

public static enum RhythmVoice.Type
extends Enum<RhythmVoice.Type>

The main types of a rhythm voice.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BASS
CHORD1
CHORD2
DRUMS
OTHER
PAD
PERCUSSION
PHRASE1
PHRASE2

Method Summary

Modifier and Type	Method	Description
GM1Instrument	getDefaultInstrument()	Return a default instrument for each type.
boolean	isDrums()
static RhythmVoice.Type	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RhythmVoice.Type[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DRUMS

public static final RhythmVoice.Type DRUMS

PERCUSSION

public static final RhythmVoice.Type PERCUSSION

BASS

public static final RhythmVoice.Type BASS

CHORD1

public static final RhythmVoice.Type CHORD1

CHORD2

public static final RhythmVoice.Type CHORD2

PHRASE1

public static final RhythmVoice.Type PHRASE1

PHRASE2

public static final RhythmVoice.Type PHRASE2

PAD

public static final RhythmVoice.Type PAD

OTHER

public static final RhythmVoice.Type OTHER

Method Details

values

public static RhythmVoice.Type[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static RhythmVoice.Type valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

isDrums

public boolean isDrums()

getDefaultInstrument

public GM1Instrument getDefaultInstrument()

Return a default instrument for each type.

Returns:

Null for Drums or Percussion.