src/share/classes/javax/sound/midi/Transmitter.java
Print this page
@@ -1,7 +1,7 @@
/*
- * Copyright (c) 1999, 2010, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1999, 2014, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
@@ -23,54 +23,51 @@
* questions.
*/
package javax.sound.midi;
-
/**
- * A <code>Transmitter</code> sends <code>{@link MidiEvent}</code> objects to one or more
- * <code>{@link Receiver Receivers}</code>. Common MIDI transmitters include sequencers
- * and MIDI input ports.
- *
- * @see Receiver
+ * A {@code Transmitter} sends {@link MidiEvent} objects to one or more
+ * {@link Receiver Receivers}. Common MIDI transmitters include sequencers and
+ * MIDI input ports.
*
* @author Kara Kytle
+ * @see Receiver
*/
public interface Transmitter extends AutoCloseable {
-
/**
* Sets the receiver to which this transmitter will deliver MIDI messages.
* If a receiver is currently set, it is replaced with this one.
- * @param receiver the desired receiver.
+ *
+ * @param receiver the desired receiver
*/
- public void setReceiver(Receiver receiver);
-
+ void setReceiver(Receiver receiver);
/**
- * Obtains the current receiver to which this transmitter will deliver MIDI messages.
- * @return the current receiver. If no receiver is currently set,
- * returns <code>null</code>
+ * Obtains the current receiver to which this transmitter will deliver MIDI
+ * messages.
+ *
+ * @return the current receiver. If no receiver is currently set, returns
+ * {@code null}.
*/
- public Receiver getReceiver();
-
+ Receiver getReceiver();
/**
* Indicates that the application has finished using the transmitter, and
* that limited resources it requires may be released or made available.
- *
- * <p>If the creation of this <code>Transmitter</code> resulted in
- * implicitly opening the underlying device, the device is
- * implicitly closed by this method. This is true unless the device is
- * kept open by other <code>Receiver</code> or <code>Transmitter</code>
- * instances that opened the device implicitly, and unless the device
- * has been opened explicitly. If the device this
- * <code>Transmitter</code> is retrieved from is closed explicitly
- * by calling {@link MidiDevice#close MidiDevice.close}, the
- * <code>Transmitter</code> is closed, too. For a detailed
- * description of open/close behaviour see the class description
- * of {@link javax.sound.midi.MidiDevice MidiDevice}.
+ * <p>
+ * If the creation of this {@code Transmitter} resulted in implicitly
+ * opening the underlying device, the device is implicitly closed by this
+ * method. This is true unless the device is kept open by other
+ * {@code Receiver} or {@code Transmitter} instances that opened the device
+ * implicitly, and unless the device has been opened explicitly. If the
+ * device this {@code Transmitter} is retrieved from is closed explicitly by
+ * calling {@link MidiDevice#close MidiDevice.close}, the
+ * {@code Transmitter} is closed, too. For a detailed description of
+ * open/close behaviour see the class description of
+ * {@link MidiDevice MidiDevice}.
*
* @see javax.sound.midi.MidiSystem#getTransmitter
*/
- public void close();
+ void close();
}