Source for javax.sound.midi.spi.MidiDeviceProvider

   1: /* MidiDeviceProvider.java -- Abstract parent for a MIDI device provider.
   2:    Copyright (C) 2005 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package javax.sound.midi.spi;
  40: 
  41: import javax.sound.midi.*;
  42: 
  43: /**
  44:  * The abstract base class for all MidiDeviceProvider types.
  45:  * 
  46:  * @author Anthony Green (green@redhat.com)
  47:  * @since 1.3
  48:  *
  49:  */
  50: public abstract class MidiDeviceProvider
  51: {
  52:   /**
  53:    * Returns true if this provider supports a specific MIDI device.
  54:    * 
  55:    * @param info the MIDI device descriptor
  56:    * @return true if this provider supports info
  57:    */
  58:   public boolean isDeviceSupported(MidiDevice.Info info)
  59:   {
  60:     MidiDevice.Info infos[] = getDeviceInfo();
  61:     
  62:     int i = infos.length;
  63:     
  64:     while (i > 0)
  65:     {
  66:       if (info.equals(infos[--i]))
  67:         return true;
  68:     }
  69:     
  70:     return false;
  71:   }
  72:   
  73:   /**
  74:    * Get the list descriptors for all MIDI devices supported by
  75:    * this provider.
  76:    * 
  77:    * @return an array of descriptors for all supported MIDI devices.
  78:    */
  79:   public abstract MidiDevice.Info[] getDeviceInfo();
  80:   
  81:   /**
  82:    * Get the MidiDevice for the MIDI device described by info
  83:    * 
  84:    * @param info the descriptor for the MIDI device we want
  85:    * @return the MidiDevice we're looking for
  86:    * @throws IllegalArgumentException is this provider doesn't support info
  87:    */
  88:   public abstract MidiDevice getDevice(MidiDevice.Info info)
  89:     throws IllegalArgumentException;
  90: }