001/* MidiDeviceProvider.java -- Abstract parent for a MIDI device provider. 002 Copyright (C) 2005 Free Software Foundation, Inc. 003 004This file is part of GNU Classpath. 005 006GNU Classpath is free software; you can redistribute it and/or modify 007it under the terms of the GNU General Public License as published by 008the Free Software Foundation; either version 2, or (at your option) 009any later version. 010 011GNU Classpath is distributed in the hope that it will be useful, but 012WITHOUT ANY WARRANTY; without even the implied warranty of 013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014General Public License for more details. 015 016You should have received a copy of the GNU General Public License 017along with GNU Classpath; see the file COPYING. If not, write to the 018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 01902110-1301 USA. 020 021Linking this library statically or dynamically with other modules is 022making a combined work based on this library. Thus, the terms and 023conditions of the GNU General Public License cover the whole 024combination. 025 026As a special exception, the copyright holders of this library give you 027permission to link this library with independent modules to produce an 028executable, regardless of the license terms of these independent 029modules, and to copy and distribute the resulting executable under 030terms of your choice, provided that you also meet, for each linked 031independent module, the terms and conditions of the license of that 032module. An independent module is a module which is not derived from 033or based on this library. If you modify this library, you may extend 034this exception to your version of the library, but you are not 035obligated to do so. If you do not wish to do so, delete this 036exception statement from your version. */ 037 038 039package javax.sound.midi.spi; 040 041import javax.sound.midi.*; 042 043/** 044 * The abstract base class for all MidiDeviceProvider types. 045 * 046 * @author Anthony Green (green@redhat.com) 047 * @since 1.3 048 * 049 */ 050public abstract class MidiDeviceProvider 051{ 052 /** 053 * Returns true if this provider supports a specific MIDI device. 054 * 055 * @param info the MIDI device descriptor 056 * @return true if this provider supports info 057 */ 058 public boolean isDeviceSupported(MidiDevice.Info info) 059 { 060 MidiDevice.Info infos[] = getDeviceInfo(); 061 062 int i = infos.length; 063 064 while (i > 0) 065 { 066 if (info.equals(infos[--i])) 067 return true; 068 } 069 070 return false; 071 } 072 073 /** 074 * Get the list descriptors for all MIDI devices supported by 075 * this provider. 076 * 077 * @return an array of descriptors for all supported MIDI devices. 078 */ 079 public abstract MidiDevice.Info[] getDeviceInfo(); 080 081 /** 082 * Get the MidiDevice for the MIDI device described by info 083 * 084 * @param info the descriptor for the MIDI device we want 085 * @return the MidiDevice we're looking for 086 * @throws IllegalArgumentException is this provider doesn't support info 087 */ 088 public abstract MidiDevice getDevice(MidiDevice.Info info) 089 throws IllegalArgumentException; 090}