javax.sound.midi

Class SysexMessage

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.
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. status must be either 0xF0 or 0xF7.

Methods inherited from class javax.sound.midi.MidiMessage

clone, getLength, getMessage, getStatus, setMessage

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SPECIAL_SYSTEM_EXCLUSIVE

public static final int SPECIAL_SYSTEM_EXCLUSIVE
Field Value:
247

SYSTEM_EXCLUSIVE

public static final int SYSTEM_EXCLUSIVE
Field Value:
240

Constructor Details

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 Details

clone

public Object clone()
This method may be called to create a new copy of the Object. The typical behavior is as follows:
  • o == o.clone() is false
  • o.getClass() == o.clone().getClass() is true
  • o.equals(o) is true

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 interface MidiMessage
Returns:
a copy of the Object
See Also:
Cloneable

getData

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

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 interface 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

SysexMessage.java -- System Exclusive MIDI message. Copyright (C) 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.