javax.sound.midi
Class SysexMessage

java.lang.Object
  extended by javax.sound.midi.MidiMessage
      extended by javax.sound.midi.SysexMessage
All Implemented Interfaces:
Cloneable

public class SysexMessage
extends MidiMessage

A system exclusive MIDI message.

Since:
1.3

Field Summary
static int SPECIAL_SYSTEM_EXCLUSIVE
           
static int SYSTEM_EXCLUSIVE
           
 
Fields inherited from class javax.sound.midi.MidiMessage
data, length
 
Constructor Summary
  SysexMessage()
          Create a default valid system exclusive message.
protected SysexMessage(byte[] data)
          Create a SysexMessage object.
 
Method Summary
 Object clone()
          This method may be called to create a new copy of the Object.
 byte[] getData()
          Get the data for this message, not including the status byte.
 void setMessage(byte[] data, int length)
          Set the sysex message.
 void setMessage(int status, byte[] data, int length)
          Set the sysex message.
 
Methods inherited from class javax.sound.midi.MidiMessage
getLength, getMessage, getStatus
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SYSTEM_EXCLUSIVE

public static final int SYSTEM_EXCLUSIVE
See Also:
Constant Field Values

SPECIAL_SYSTEM_EXCLUSIVE

public static final int SPECIAL_SYSTEM_EXCLUSIVE
See Also:
Constant Field Values
Constructor Detail

SysexMessage

public SysexMessage()
Create a default valid system exclusive message. The official specs don't specify what message is to be created. Our implementation creates an empty system exclusive message.


SysexMessage

protected SysexMessage(byte[] data)
Create a SysexMessage object.

Parameters:
data - a complete system exclusive message
Method Detail

setMessage

public void setMessage(byte[] data,
                       int length)
                throws InvalidMidiDataException
Set the sysex message. The first data byte (status) must be 0xF0 or 0xF7.

Overrides:
setMessage in class MidiMessage
Parameters:
data - the message data
length - the length of the message data
Throws:
InvalidMidiDataException - if the status byte is not 0xF0 or 0xF7

setMessage

public void setMessage(int status,
                       byte[] data,
                       int length)
                throws InvalidMidiDataException
Set the sysex message. status must be either 0xF0 or 0xF7.

Parameters:
status - the sysex statys byte (0xF0 or 0xF7)
data - the message data
length - the length of the message data
Throws:
InvalidMidiDataException - if status is not 0xF0 or 0xF7

getData

public byte[] getData()
Get the data for this message, not including the status byte.

Returns:
the message data, not including the status byte

clone

public 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());
     }
 }
 

Specified by:
clone in class MidiMessage
Returns:
a copy of the Object
See Also:
Cloneable