jdk/src/share/classes/javax/sound/midi/spi/MidiDeviceProvider.java
author serb
Fri, 21 Mar 2014 16:51:53 +0400
changeset 23688 6781b500dfca
parent 5506 202f599c92aa
permissions -rw-r--r--
8037117: Javadoc cleanup of javax.sound.midi.spi package Reviewed-by: art, pchelko
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
import javax.sound.midi.MidiDevice;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
/**
23688
6781b500dfca 8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents: 5506
diff changeset
    31
 * 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
    32
 * 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
    33
 * resources are managed in the creation and management of a device.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
 * @author Kara Kytle
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
public abstract class MidiDeviceProvider {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
     * Indicates whether the device provider supports the device represented by
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
     * the specified device info object.
23688
6781b500dfca 8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents: 5506
diff changeset
    42
     *
6781b500dfca 8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents: 5506
diff changeset
    43
     * @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
    44
     *         is queried
6781b500dfca 8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents: 5506
diff changeset
    45
     * @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
    46
     *         {@code false}
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
    public boolean isDeviceSupported(MidiDevice.Info info) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
        MidiDevice.Info infos[] = getDeviceInfo();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
        for(int i=0; i<infos.length; i++) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
            if( info.equals( infos[i] ) ) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
                return true;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
            }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
        return false;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
    /**
23688
6781b500dfca 8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents: 5506
diff changeset
    61
     * 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
    62
     * provided by this {@code MidiDeviceProvider}.
6781b500dfca 8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents: 5506
diff changeset
    63
     *
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
     * @return set of device info objects
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
    public abstract MidiDevice.Info[] getDeviceInfo();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
     * 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
    70
     *
6781b500dfca 8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents: 5506
diff changeset
    71
     * @param  info an info object that describes the desired device
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
     * @return device instance
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
     * @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
    74
     *         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
    75
     *         {@code MidiDeviceProvider}
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
    public abstract MidiDevice getDevice(MidiDevice.Info info);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
}