javax.sound.midi

Class MidiMessage

Implemented Interfaces:
Cloneable
Known Direct 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

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

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

Field Details

data

protected byte[] data
MIDI message data.

length

protected int length
The total length of the MIDI message.

Constructor Details

MidiMessage

protected MidiMessage(byte[] data)
MidiMessage contructor.
Parameters:
data - a valid MIDI message

Method Details

clone

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

getLength

public int getLength()
Get the length of the MIDI message.
Returns:
the length of the MIDI messsage

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.

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.

MidiMessage.java -- base class for MIDI messages. 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.