Package org.jjazz.midi.api

Class DrumKit

java.lang.Object

org.jjazz.midi.api.DrumKit

All Implemented Interfaces:

Serializable

public class DrumKit
extends Object
implements Serializable

The main parameters of a drum kit instrument: a drum/key map and its ambiance type.

This is an immutable class.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DrumKit.KeyMap	Defines a key map for a drumkit: associate a percussion name to a note pitch.
static enum	DrumKit.Subset	Subset of instruments (pitches) of a in a KeyMap.
static enum	DrumKit.Type	The main ambience types based on GM2 standard.

Constructor Summary

Constructors

Constructor	Description
DrumKit()	Create a DrumKit with type=STANDARD and keyMap=GM
DrumKit(DrumKit.Type type, DrumKit.KeyMap map)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
DrumKit.KeyMap	getKeyMap()
Map<Integer,DrumKit.Subset>	getSubsetPitches(DrumKit.Subset... subsets)	Get a map which provide the subset corresponding to a pitch for this DrumKit.
DrumKit.Type	getType()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

DrumKit

public DrumKit()

Create a DrumKit with type=STANDARD and keyMap=GM

DrumKit

public DrumKit(DrumKit.Type type,
 DrumKit.KeyMap map)

Method Details

getType

public DrumKit.Type getType()

Returns:

the type

getKeyMap

public DrumKit.KeyMap getKeyMap()

Returns:

the map

getSubsetPitches

public Map<Integer,DrumKit.Subset> getSubsetPitches(DrumKit.Subset... subsets)

Get a map which provide the subset corresponding to a pitch for this DrumKit.

Parameters:

subsets - Limit the map values to these subsets only. If no value specified, use all the possible Subsets values.

Returns:

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object