jdk-sandbox: jdk/src/java.desktop/share/classes/javax/sound/midi/spi/MidiDeviceProvider.java@3afa6296f688 (annotated)

2 90ce3da70b43 Initial load duke parents: diff changeset	1	/*
23688 6781b500dfca 8037117: Javadoc cleanup of javax.sound.midi.spi package serb parents: 5506 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.spi;
90ce3da70b43 Initial load duke parents: diff changeset	27
27061 3afa6296f688 8058115: Some of MidiDeviceProviders do not follow the specification serb parents: 25859 diff changeset	28	import java.util.Arrays;
3afa6296f688 8058115: Some of MidiDeviceProviders do not follow the specification serb parents: 25859 diff changeset	29
2 90ce3da70b43 Initial load duke parents: diff changeset	30	import javax.sound.midi.MidiDevice;
90ce3da70b43 Initial load duke parents: diff changeset	31
90ce3da70b43 Initial load duke parents: diff changeset	32	/**
23688 6781b500dfca 8037117: Javadoc cleanup of javax.sound.midi.spi package serb parents: 5506 diff changeset	33	* A {@code MidiDeviceProvider} is a factory or provider for a particular type
6781b500dfca 8037117: Javadoc cleanup of javax.sound.midi.spi package serb parents: 5506 diff changeset	34	* of MIDI device. This mechanism allows the implementation to determine how
6781b500dfca 8037117: Javadoc cleanup of javax.sound.midi.spi package serb parents: 5506 diff changeset	35	* resources are managed in the creation and management of a device.
2 90ce3da70b43 Initial load duke parents: diff changeset	36	*
90ce3da70b43 Initial load duke parents: diff changeset	37	* @author Kara Kytle
90ce3da70b43 Initial load duke parents: diff changeset	38	*/
90ce3da70b43 Initial load duke parents: diff changeset	39	public abstract class MidiDeviceProvider {
90ce3da70b43 Initial load duke parents: diff changeset	40
90ce3da70b43 Initial load duke parents: diff changeset	41	/**
90ce3da70b43 Initial load duke parents: diff changeset	42	* Indicates whether the device provider supports the device represented by
90ce3da70b43 Initial load duke parents: diff changeset	43	* the specified device info object.
23688 6781b500dfca 8037117: Javadoc cleanup of javax.sound.midi.spi package serb parents: 5506 diff changeset	44	*
6781b500dfca 8037117: Javadoc cleanup of javax.sound.midi.spi package serb parents: 5506 diff changeset	45	* @param info an info object that describes the device for which support
6781b500dfca 8037117: Javadoc cleanup of javax.sound.midi.spi package serb parents: 5506 diff changeset	46	* is queried
6781b500dfca 8037117: Javadoc cleanup of javax.sound.midi.spi package serb parents: 5506 diff changeset	47	* @return {@code true} if the specified device is supported, otherwise
6781b500dfca 8037117: Javadoc cleanup of javax.sound.midi.spi package serb parents: 5506 diff changeset	48	* {@code false}
2 90ce3da70b43 Initial load duke parents: diff changeset	49	*/
27061 3afa6296f688 8058115: Some of MidiDeviceProviders do not follow the specification serb parents: 25859 diff changeset	50	public boolean isDeviceSupported(final MidiDevice.Info info) {
3afa6296f688 8058115: Some of MidiDeviceProviders do not follow the specification serb parents: 25859 diff changeset	51	return Arrays.asList(getDeviceInfo()).contains(info);
2 90ce3da70b43 Initial load duke parents: diff changeset	52	}
90ce3da70b43 Initial load duke parents: diff changeset	53
90ce3da70b43 Initial load duke parents: diff changeset	54	/**
23688 6781b500dfca 8037117: Javadoc cleanup of javax.sound.midi.spi package serb parents: 5506 diff changeset	55	* Obtains the set of info objects representing the device or devices
6781b500dfca 8037117: Javadoc cleanup of javax.sound.midi.spi package serb parents: 5506 diff changeset	56	* provided by this {@code MidiDeviceProvider}.
6781b500dfca 8037117: Javadoc cleanup of javax.sound.midi.spi package serb parents: 5506 diff changeset	57	*
2 90ce3da70b43 Initial load duke parents: diff changeset	58	* @return set of device info objects
90ce3da70b43 Initial load duke parents: diff changeset	59	*/
90ce3da70b43 Initial load duke parents: diff changeset	60	public abstract MidiDevice.Info[] getDeviceInfo();
90ce3da70b43 Initial load duke parents: diff changeset	61
90ce3da70b43 Initial load duke parents: diff changeset	62	/**
90ce3da70b43 Initial load duke parents: diff changeset	63	* Obtains an instance of the device represented by the info object.
23688 6781b500dfca 8037117: Javadoc cleanup of javax.sound.midi.spi package serb parents: 5506 diff changeset	64	*
6781b500dfca 8037117: Javadoc cleanup of javax.sound.midi.spi package serb parents: 5506 diff changeset	65	* @param info an info object that describes the desired device
2 90ce3da70b43 Initial load duke parents: diff changeset	66	* @return device instance
90ce3da70b43 Initial load duke parents: diff changeset	67	* @throws IllegalArgumentException if the info object specified does not
23688 6781b500dfca 8037117: Javadoc cleanup of javax.sound.midi.spi package serb parents: 5506 diff changeset	68	* match the info object for a device supported by this
6781b500dfca 8037117: Javadoc cleanup of javax.sound.midi.spi package serb parents: 5506 diff changeset	69	* {@code MidiDeviceProvider}
2 90ce3da70b43 Initial load duke parents: diff changeset	70	*/
90ce3da70b43 Initial load duke parents: diff changeset	71	public abstract MidiDevice getDevice(MidiDevice.Info info);
90ce3da70b43 Initial load duke parents: diff changeset	72	}

author	serb
	Tue, 30 Sep 2014 17:39:04 +0400
changeset 27061	3afa6296f688
parent 25859	3317bb8137f4
child 34806	65f9c9d7b623
permissions	-rw-r--r--