United StatesChange Country, Oracle Worldwide Web Sites Communities I am a... I want to...
JDK-4934158 : DOC: clean up MidiDevice documentation

Details
Type:
Bug
Submit Date:
2003-10-08
Status:
Resolved
Updated Date:
2003-10-24
Project Name:
JDK
Resolved Date:
2003-10-24
Component:
client-libs
OS:
generic
Sub-Component:
javax.sound
CPU:
generic
Priority:
P5
Resolution:
Fixed
Affected Versions:
5.0
Fixed Versions:
5.0 (b26)

Related Reports

Sub Tasks

Description
The documentation of the class javax.sound.midi.MidiDevice contains at least one obsolete and confusing comment. This should be remove. Other issues should be explained more detailled.

- (class description:) "To this end, it
 * typically also implements the <code>{@link Transmitter}</code> or
 * <code>{@link Receiver}</code> interface (or both), or has access to objects that do."
MidiDevices do not implement the interfaces Transmitter and Receiver. The wording should be changed to something like this: "A <code>MidiDevice</code>
 * can be a transmitter or a receiver of MIDI events, or both. Therefore, it
 * can provide <code>{@link Transmitter}</code> or
 * <code>{@link Receiver}</code> instances (or both). Typically, MIDI IN ports provide Transmitters, MIDI OUT ports and Synthesizers provide Receivers. Sequencers typically provide Transmitters for playback and Receivers for recording."

- for newcomers, it is not obvious how to detect if a MidiDevice represents a hardware MIDI port. The usual code snippet used for this (below) should be included in the documentation.
---
MidiDevice device = ...;
if ( ! (device instanceof Sequencer) && ! (device instanceof Synthesizer)) {
    // we're now sure that device represents a MIDI port
    // ...
}
---

- obsolete and commented out code (ThruTransmitter) should be removed.

###@###.### 2003-10-22
Checked in Bug Fix

                                    

Comments
EVALUATION


###@###.### 2003-10-08

Should be done. CCC is required.
                                     
2003-10-08
PUBLIC COMMENTS

DOC: clean up MidiDevice documentation
                                     
2004-06-10
CONVERTED DATA

BugTraq+ Release Management Values

COMMIT TO FIX:
tiger-beta

FIXED IN:
tiger-beta

INTEGRATED IN:
tiger-b26
tiger-beta


                                     
2004-06-14



Hardware and Software, Engineered to Work Together