javax.sound.midi
Class MidiMessage

java.lang.Object
  extended by 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()
          This method may be called to create a new copy of the Object.
 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
This method may be called to create a new copy of the Object. The typical behavior is as follows:

However, these are not strict requirements, and may be violated if necessary. Of the three requirements, the last is the most commonly violated, particularly if the subclass does not override Object.equals(Object).

If the Object you call clone() on does not implement Cloneable (which is a placeholder interface), then a CloneNotSupportedException is thrown. Notice that Object does not implement Cloneable; this method exists as a convenience for subclasses that do.

Object's implementation of clone allocates space for the new Object using the correct class, without calling any constructors, and then fills in all of the new field values with the old field values. Thus, it is a shallow copy. However, subclasses are permitted to make a deep copy.

All array types implement Cloneable, and override this method as follows (it should never fail):

 public Object clone()
 {
   try
     {
       super.clone();
     }
   catch (CloneNotSupportedException e)
     {
       throw new InternalError(e.getMessage());
     }
 }
 

Overrides:
clone in class Object
Returns:
a copy of the Object
See Also:
Cloneable