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