javax.sound.midi
Class MidiMessage

java.lang.Object
  javax.sound.midi.MidiMessage

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

MetaMessage, ShortMessage, SysexMessage

public abstract class MidiMessage
extends Object
implements Cloneable

The base class for all MIDI messages.

Since:

1.3

Field Summary

protected byte[]	data MIDI message data.
protected int	length The total length of the MIDI message.

Constructor Summary

protected

MidiMessage(byte[] data) MidiMessage contructor.

Method Summary

abstract Object	clone() clone creates a shallow clone of this.
int	getLength() Get the length of the MIDI message.
byte[]	getMessage() Get the MIDI message data.
int	getStatus() Get the status byte of the MIDI message (as an int)
protected void	setMessage(byte[] data, int length) Set the complete MIDI message.

Methods inherited from class java.lang.Object

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

Field Detail

data

protected byte[] data

MIDI message data.

length

protected int length

The total length of the MIDI message.

Constructor Detail

MidiMessage

protected MidiMessage(byte[] data)

MidiMessage contructor.

Parameters:

data - a valid MIDI message

Method Detail

setMessage

protected void setMessage(byte[] data,
                          int length)
                   throws InvalidMidiDataException

Set the complete MIDI message.

Parameters:

data - The complete MIDI message.

length - The length of the MIDI message.

Throws:

InvalidMidiDataException - Thrown when the MIDI message is invalid.

getMessage

public byte[] getMessage()

Get the MIDI message data.

Returns:

an array containing the MIDI message data

getStatus

public int getStatus()

Get the status byte of the MIDI message (as an int)

Returns:

the status byte of the MIDI message (as an int), or zero if the message length is zero.

getLength

public int getLength()

Get the length of the MIDI message.

Returns:

the length of the MIDI messsage

clone

public abstract Object clone()

Description copied from class: Object

clone creates a shallow clone of this.

Overrides:

clone in class Object

Returns:

a clone of this object.