org.openksavi.sponge.midi.event

Class MidiShortMessageEvent

java.lang.Object

org.openksavi.sponge.core.event.BaseEvent

org.openksavi.sponge.midi.event.MidiMessageEvent<ShortMessage>

org.openksavi.sponge.midi.event.MidiShortMessageEvent

All Implemented Interfaces:

Serializable, Cloneable, org.openksavi.sponge.event.Event, org.openksavi.sponge.util.Descriptive, org.openksavi.sponge.util.HasFeatures, org.openksavi.sponge.util.HasPriority<org.openksavi.sponge.event.Event>

public class MidiShortMessageEvent
extends MidiMessageEvent<ShortMessage>

A MIDI ShortMessage wrapped in a Sponge event.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.openksavi.sponge.midi.event.MidiMessageEvent

MidiMessageEvent.MidiEventCategory

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTR_CHANNEL The MIDI channel attribute name.
static String	ATTR_COMMAND The MIDI command attribute name.
static String	ATTR_DATA1 The MIDI data1 attribute name.
static String	ATTR_DATA2 The MIDI data2 attribute name.

Fields inherited from class org.openksavi.sponge.midi.event.MidiMessageEvent

ATTR_MESSAGE, ATTR_TIME_STAMP

Fields inherited from class org.openksavi.sponge.core.event.BaseEvent

clonePolicy, DEFAULT_PRIORITY, description, id, label, name, time

Constructor Summary

Constructors

Constructor and Description
MidiShortMessageEvent(String name, org.openksavi.sponge.event.EventClonePolicy clonePolicy, ShortMessage message) Creates a new MIDI ShortMessage Sponge event.
MidiShortMessageEvent(String name, org.openksavi.sponge.event.EventClonePolicy clonePolicy, ShortMessage message, Long timeStamp) Creates a new MIDI ShortMessage Sponge event.

Method Summary

Modifier and Type	Method and Description
<T> T	doGet(String name, boolean useDefault, T defaultValue)
Map<String,Object>	getAll()
int	getChannel() Returns the MIDI short message channel.
int	getCommand() Returns the MIDI short message command.
int	getData1() Returns the MIDI short message data1.
int	getData2() Returns the MIDI short message data2.
String	getMessageString()
MidiMessageEvent.MidiEventCategory	getMidiCategory()
boolean	has(String name)
MidiShortMessageEvent	set(String name, Object value)
void	setChannel(int channel) Sets the MIDI short message channel.
void	setCommand(int command) Sets the MIDI short message command.
void	setData1(int data1) Sets the MIDI short message data1.
void	setData2(int data2) Sets the MIDI short message data2.

Methods inherited from class org.openksavi.sponge.midi.event.MidiMessageEvent

getMessage, getTimeStamp, setMessage, setTimeStamp

Methods inherited from class org.openksavi.sponge.core.event.BaseEvent

addFeature, addFeatures, clone, equalsByAttributes, equalsById, get, get, get, getDefaultAttributeValue, getDescription, getFeatures, getId, getLabel, getName, getPriority, getTime, set, setDescription, setFeatures, setId, setLabel, setName, setTime, toString, toStringBase, validateAttribute, validateFeature

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ATTR_COMMAND

public static final String ATTR_COMMAND

The MIDI command attribute name.

See Also:

Constant Field Values

ATTR_CHANNEL

public static final String ATTR_CHANNEL

The MIDI channel attribute name.

See Also:

Constant Field Values

ATTR_DATA1

public static final String ATTR_DATA1

The MIDI data1 attribute name.

See Also:

Constant Field Values

ATTR_DATA2

public static final String ATTR_DATA2

The MIDI data2 attribute name.

See Also:

Constant Field Values

Constructor Detail

MidiShortMessageEvent

public MidiShortMessageEvent(String name,
                             org.openksavi.sponge.event.EventClonePolicy clonePolicy,
                             ShortMessage message,
                             Long timeStamp)

Creates a new MIDI ShortMessage Sponge event.

Parameters:

name - the event name.

clonePolicy - the event clone policy.

message - the MIDI ShortMessage.

timeStamp - the MIDI timeStamp.

MidiShortMessageEvent

public MidiShortMessageEvent(String name,
                             org.openksavi.sponge.event.EventClonePolicy clonePolicy,
                             ShortMessage message)

Creates a new MIDI ShortMessage Sponge event.

Parameters:

name - the event name.

clonePolicy - the event clone policy.

message - the MIDI ShortMessage.

Method Detail

getCommand

public int getCommand()

Returns the MIDI short message command.

Returns:

the MIDI short message command.

setCommand

public void setCommand(int command)

Sets the MIDI short message command.

Parameters:

command - the MIDI short message command.

getChannel

public int getChannel()

Returns the MIDI short message channel.

Returns:

the MIDI short message channel.

setChannel

public void setChannel(int channel)

Sets the MIDI short message channel.

Parameters:

channel - the MIDI short message channel.

getData1

public int getData1()

Returns the MIDI short message data1.

Returns:

the MIDI short message data1.

setData1

public void setData1(int data1)

Sets the MIDI short message data1.

Parameters:

data1 - the MIDI short message data1.

getData2

public int getData2()

Returns the MIDI short message data2.

Returns:

the MIDI short message data2.

setData2

public void setData2(int data2)

Sets the MIDI short message data2.

Parameters:

data2 - the MIDI short message data2.

doGet

public <T> T doGet(String name,
                   boolean useDefault,
                   T defaultValue)

Overrides:

doGet in class MidiMessageEvent<ShortMessage>

set

public MidiShortMessageEvent set(String name,
                                 Object value)

Specified by:

set in interface org.openksavi.sponge.event.Event

Overrides:

set in class MidiMessageEvent<ShortMessage>

has

public boolean has(String name)

Specified by:

has in interface org.openksavi.sponge.event.Event

Overrides:

has in class MidiMessageEvent<ShortMessage>

getAll

public Map<String,Object> getAll()

Specified by:

getAll in interface org.openksavi.sponge.event.Event

Overrides:

getAll in class MidiMessageEvent<ShortMessage>

getMidiCategory

public MidiMessageEvent.MidiEventCategory getMidiCategory()

Specified by:

getMidiCategory in class MidiMessageEvent<ShortMessage>

getMessageString

public String getMessageString()

Specified by:

getMessageString in class MidiMessageEvent<ShortMessage>