jdk/src/java.desktop/share/classes/javax/sound/midi/Receiver.java
author ddehaven
Tue, 19 Aug 2014 10:32:16 -0700
changeset 26037 508779ce6619
parent 26003 jdk/src/share/classes/javax/sound/midi/Receiver.java@d630c97424bd
parent 25859 jdk/src/share/classes/javax/sound/midi/Receiver.java@3317bb8137f4
child 40444 afabcfc2f3ef
permissions -rw-r--r--
Merge
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
26003
d630c97424bd 8050852: Javadoc cleanup of javax.sound.midi package
serb
parents: 7668
diff changeset
     2
 * Copyright (c) 1999, 2014, Oracle and/or its affiliates. All rights reserved.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    23
 * questions.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
package javax.sound.midi;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
/**
26003
d630c97424bd 8050852: Javadoc cleanup of javax.sound.midi package
serb
parents: 7668
diff changeset
    29
 * A {@code Receiver} receives {@link MidiEvent} objects and typically does
d630c97424bd 8050852: Javadoc cleanup of javax.sound.midi package
serb
parents: 7668
diff changeset
    30
 * something useful in response, such as interpreting them to generate sound or
d630c97424bd 8050852: Javadoc cleanup of javax.sound.midi package
serb
parents: 7668
diff changeset
    31
 * raw MIDI output. Common MIDI receivers include synthesizers and MIDI Out
d630c97424bd 8050852: Javadoc cleanup of javax.sound.midi package
serb
parents: 7668
diff changeset
    32
 * ports.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
 *
26003
d630c97424bd 8050852: Javadoc cleanup of javax.sound.midi package
serb
parents: 7668
diff changeset
    34
 * @author Kara Kytle
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
 * @see MidiDevice
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
 * @see Synthesizer
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
 * @see Transmitter
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
 */
5998
586c1b1dbb10 6963723: Project Coin: Retrofit more JDK classes for ARM
darcy
parents: 5506
diff changeset
    39
public interface Receiver extends AutoCloseable {
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
26003
d630c97424bd 8050852: Javadoc cleanup of javax.sound.midi package
serb
parents: 7668
diff changeset
    41
    //$$fb 2002-04-12: fix for 4662090: Contradiction in Receiver specification
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
    /**
26003
d630c97424bd 8050852: Javadoc cleanup of javax.sound.midi package
serb
parents: 7668
diff changeset
    44
     * Sends a MIDI message and time-stamp to this receiver. If time-stamping is
d630c97424bd 8050852: Javadoc cleanup of javax.sound.midi package
serb
parents: 7668
diff changeset
    45
     * not supported by this receiver, the time-stamp value should be -1.
d630c97424bd 8050852: Javadoc cleanup of javax.sound.midi package
serb
parents: 7668
diff changeset
    46
     *
d630c97424bd 8050852: Javadoc cleanup of javax.sound.midi package
serb
parents: 7668
diff changeset
    47
     * @param  message the MIDI message to send
d630c97424bd 8050852: Javadoc cleanup of javax.sound.midi package
serb
parents: 7668
diff changeset
    48
     * @param  timeStamp the time-stamp for the message, in microseconds
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
     * @throws IllegalStateException if the receiver is closed
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
     */
26003
d630c97424bd 8050852: Javadoc cleanup of javax.sound.midi package
serb
parents: 7668
diff changeset
    51
    void send(MidiMessage message, long timeStamp);
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
    /**
26003
d630c97424bd 8050852: Javadoc cleanup of javax.sound.midi package
serb
parents: 7668
diff changeset
    54
     * Indicates that the application has finished using the receiver, and that
d630c97424bd 8050852: Javadoc cleanup of javax.sound.midi package
serb
parents: 7668
diff changeset
    55
     * limited resources it requires may be released or made available.
d630c97424bd 8050852: Javadoc cleanup of javax.sound.midi package
serb
parents: 7668
diff changeset
    56
     * <p>
d630c97424bd 8050852: Javadoc cleanup of javax.sound.midi package
serb
parents: 7668
diff changeset
    57
     * If the creation of this {@code Receiver} resulted in implicitly opening
d630c97424bd 8050852: Javadoc cleanup of javax.sound.midi package
serb
parents: 7668
diff changeset
    58
     * the underlying device, the device is implicitly closed by this method.
d630c97424bd 8050852: Javadoc cleanup of javax.sound.midi package
serb
parents: 7668
diff changeset
    59
     * This is true unless the device is kept open by other {@code Receiver} or
d630c97424bd 8050852: Javadoc cleanup of javax.sound.midi package
serb
parents: 7668
diff changeset
    60
     * {@code Transmitter} instances that opened the device implicitly, and
d630c97424bd 8050852: Javadoc cleanup of javax.sound.midi package
serb
parents: 7668
diff changeset
    61
     * unless the device has been opened explicitly. If the device this
d630c97424bd 8050852: Javadoc cleanup of javax.sound.midi package
serb
parents: 7668
diff changeset
    62
     * {@code Receiver} is retrieved from is closed explicitly by calling
d630c97424bd 8050852: Javadoc cleanup of javax.sound.midi package
serb
parents: 7668
diff changeset
    63
     * {@link MidiDevice#close MidiDevice.close}, the {@code Receiver} is
d630c97424bd 8050852: Javadoc cleanup of javax.sound.midi package
serb
parents: 7668
diff changeset
    64
     * closed, too. For a detailed description of open/close behaviour see the
d630c97424bd 8050852: Javadoc cleanup of javax.sound.midi package
serb
parents: 7668
diff changeset
    65
     * class description of {@link MidiDevice MidiDevice}.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
     * @see javax.sound.midi.MidiSystem#getReceiver
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
     */
26003
d630c97424bd 8050852: Javadoc cleanup of javax.sound.midi package
serb
parents: 7668
diff changeset
    69
    void close();
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
}