1 /* 2 * Copyright (c) 1999, 2015, 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.spi; 27 28 import java.util.Arrays; 29 import java.util.Objects; 30 31 import javax.sound.midi.MidiDevice; 32 33 /** 34 * A {@code MidiDeviceProvider} is a factory or provider for a particular type 35 * of MIDI device. This mechanism allows the implementation to determine how 36 * resources are managed in the creation and management of a device. 37 * 38 * @author Kara Kytle 39 */ 40 public abstract class MidiDeviceProvider { 41 42 /** 43 * Indicates whether the device provider supports the device represented by 44 * the specified device info object. 45 * 46 * @param info an info object that describes the device for which support 47 * is queried 48 * @return {@code true} if the specified device is supported, otherwise 49 * {@code false} 50 * @throws NullPointerException if {@code info} is {@code null} 51 */ 52 public boolean isDeviceSupported(final MidiDevice.Info info) { 53 Objects.requireNonNull(info); 54 return Arrays.asList(getDeviceInfo()).contains(info); 55 } 56 57 /** 58 * Obtains the set of info objects representing the device or devices 59 * provided by this {@code MidiDeviceProvider}. 60 * 61 * @return set of device info objects 62 */ 63 public abstract MidiDevice.Info[] getDeviceInfo(); 64 65 /** 66 * Obtains an instance of the device represented by the info object. 67 * 68 * @param info an info object that describes the desired device 69 * @return device instance 70 * @throws IllegalArgumentException if the info object specified does not 71 * match the info object for a device supported by this 72 * {@code MidiDeviceProvider} 73 * @throws NullPointerException if {@code info} is {@code null} 74 */ 75 public abstract MidiDevice getDevice(MidiDevice.Info info); 76 }