4895403: SPEC: documentation of javax.sound.sampled.spi.MixerProvider should be detailed
Reviewed-by: malenkov
--- a/jdk/src/share/classes/javax/sound/sampled/spi/MixerProvider.java Fri Apr 17 15:10:05 2009 +0400
+++ b/jdk/src/share/classes/javax/sound/sampled/spi/MixerProvider.java Fri Apr 17 15:11:43 2009 +0400
@@ -42,9 +42,15 @@
/**
* Indicates whether the mixer provider supports the mixer represented by
* the specified mixer info object.
+ * <p>
+ * The full set of mixer info objects that represent the mixers supported
+ * by this {@code MixerProvider} may be obtained
+ * through the {@code getMixerInfo} method.
+ *
* @param info an info object that describes the mixer for which support is queried
- * @return <code>true</code> if the specified mixer is supported,
- * otherwise <code>false</code>
+ * @return {@code true} if the specified mixer is supported,
+ * otherwise {@code false}
+ * @see #getMixerInfo()
*/
public boolean isMixerSupported(Mixer.Info info) {
@@ -62,17 +68,34 @@
/**
* Obtains the set of info objects representing the mixer
* or mixers provided by this MixerProvider.
- * @return set of mixer info objects
+ * <p>
+ * The {@code isMixerSupported} method returns {@code true}
+ * for all the info objects returned by this method.
+ * The corresponding mixer instances for the info objects
+ * are returned by the {@code getMixer} method.
+ *
+ * @return a set of mixer info objects
+ * @see #getMixer(javax.sound.sampled.Mixer.Info) getMixer(Mixer.Info)
+ * @see #isMixerSupported(javax.sound.sampled.Mixer.Info) isMixerSupported(Mixer.Info)
*/
public abstract Mixer.Info[] getMixerInfo();
/**
* Obtains an instance of the mixer represented by the info object.
+ * <p>
+ * The full set of the mixer info objects that represent the mixers
+ * supported by this {@code MixerProvider} may be obtained
+ * through the {@code getMixerInfo} method.
+ * Use the {@code isMixerSupported} method to test whether
+ * this {@code MixerProvider} supports a particular mixer.
+ *
* @param info an info object that describes the desired mixer
* @return mixer instance
* @throws IllegalArgumentException if the info object specified does not
- * match the info object for a mixer supported by this MixerProvider.
+ * match the info object for a mixer supported by this MixerProvider.
+ * @see #getMixerInfo()
+ * @see #isMixerSupported(javax.sound.sampled.Mixer.Info) isMixerSupported(Mixer.Info)
*/
public abstract Mixer getMixer(Mixer.Info info);
}