org.openksavi.sponge.midi.event

Class MidiMessageEvent<M extends MidiMessage>

java.lang.Object

org.openksavi.sponge.core.event.BaseEvent

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

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>

Direct Known Subclasses:

MidiMetaMessageEvent, MidiShortMessageEvent, MidiSysexMessageEvent

public abstract class MidiMessageEvent<M extends MidiMessage>
extends BaseEvent

A MIDI Message wrapped in a Sponge event.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MidiMessageEvent.MidiEventCategory A MIDI-based Sponge event category.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTR_MESSAGE The MIDI message attribute name.
static String	ATTR_TIME_STAMP The MIDI timeStamp attribute name.

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

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
<T> T	doGet(String name, boolean useDefault, T defaultValue)
Map<String,Object>	getAll()
M	getMessage() Returns the MIDI message.
abstract String	getMessageString()
abstract MidiMessageEvent.MidiEventCategory	getMidiCategory()
Long	getTimeStamp() Returns the MIDI timeStamp.
boolean	has(String name)
MidiMessageEvent<M>	set(String name, Object value)
void	setMessage(M message) Sets the MIDI message.
void	setTimeStamp(Long timeStamp) Sets the MIDI timeStamp.

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_MESSAGE

public static final String ATTR_MESSAGE

The MIDI message attribute name.

See Also:

Constant Field Values

ATTR_TIME_STAMP

public static final String ATTR_TIME_STAMP

The MIDI timeStamp attribute name.

See Also:

Constant Field Values

Constructor Detail

MidiMessageEvent

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

Creates a new MIDI Message Sponge event.

Parameters:

name - the event name.

clonePolicy - the event clone policy.

message - the MIDI Message.

timeStamp - the MIDI timeStamp.

MidiMessageEvent

public MidiMessageEvent(String name,
                        org.openksavi.sponge.event.EventClonePolicy clonePolicy,
                        M message)

Creates a new MIDI Message Sponge event.

Parameters:

name - the event name.

clonePolicy - the event clone policy.

message - the MIDI ShortMessage.

Method Detail

getMessage

public M getMessage()

Returns the MIDI message.

Returns:

the MIDI message.

setMessage

public void setMessage(M message)

Sets the MIDI message.

Parameters:

message - the MIDI message.

getTimeStamp

public Long getTimeStamp()

Returns the MIDI timeStamp.

Returns:

the MIDI timeStamp.

setTimeStamp

public void setTimeStamp(Long timeStamp)

Sets the MIDI timeStamp.

Parameters:

timeStamp - the MIDI timeStamp.

doGet

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

Specified by:

doGet in class BaseEvent

set

public MidiMessageEvent<M> set(String name,
                               Object value)

has

public boolean has(String name)

getAll

public Map<String,Object> getAll()

getMidiCategory

public abstract MidiMessageEvent.MidiEventCategory getMidiCategory()

getMessageString

public abstract String getMessageString()