1 /*
   2  * Copyright (c) 1999, 2010, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package javax.sound.midi;
  27 
  28 
  29 /**
  30  * A <code>Transmitter</code> sends <code>{@link MidiEvent}</code> objects to one or more
  31  * <code>{@link Receiver Receivers}</code>. Common MIDI transmitters include sequencers
  32  * and MIDI input ports.
  33  *
  34  * @see Receiver
  35  *
  36  * @author Kara Kytle
  37  */
  38 public interface Transmitter extends AutoCloseable {
  39 
  40 
  41     /**
  42      * Sets the receiver to which this transmitter will deliver MIDI messages.
  43      * If a receiver is currently set, it is replaced with this one.
  44      * @param receiver the desired receiver.
  45      */
  46     public void setReceiver(Receiver receiver);
  47 
  48 
  49     /**
  50      * Obtains the current receiver to which this transmitter will deliver MIDI messages.
  51      * @return the current receiver.  If no receiver is currently set,
  52      * returns <code>null</code>
  53      */
  54     public Receiver getReceiver();
  55 
  56 
  57     /**
  58      * Indicates that the application has finished using the transmitter, and
  59      * that limited resources it requires may be released or made available.
  60      *
  61      * <p>If the creation of this <code>Transmitter</code> resulted in
  62      * implicitly opening the underlying device, the device is
  63      * implicitly closed by this method. This is true unless the device is
  64      * kept open by other <code>Receiver</code> or <code>Transmitter</code>
  65      * instances that opened the device implicitly, and unless the device
  66      * has been opened explicitly. If the device this
  67      * <code>Transmitter</code> is retrieved from is closed explicitly
  68      * by calling {@link MidiDevice#close MidiDevice.close}, the
  69      * <code>Transmitter</code> is closed, too.  For a detailed
  70      * description of open/close behaviour see the class description
  71      * of {@link javax.sound.midi.MidiDevice MidiDevice}.
  72      *
  73      * @see javax.sound.midi.MidiSystem#getTransmitter
  74      */
  75     public void close();
  76 }