1 /*
   2  * Copyright (c) 1999, 2014, 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.io.File;
  29 import java.io.IOException;
  30 import java.io.InputStream;
  31 import java.net.URL;
  32 
  33 import javax.sound.midi.InvalidMidiDataException;
  34 import javax.sound.midi.Soundbank;

  35 
  36 /**
  37  * A {@code SoundbankReader} supplies soundbank file-reading services. Concrete
  38  * subclasses of {@code SoundbankReader} parse a given soundbank file, producing
  39  * a {@link javax.sound.midi.Soundbank} object that can be loaded into a
  40  * {@link javax.sound.midi.Synthesizer}.
  41  *
  42  * @since 1.3
  43  * @author Kara Kytle
  44  */
  45 public abstract class SoundbankReader {
  46 
  47     /**
  48      * Obtains a soundbank object from the URL provided.
  49      *
  50      * @param  url URL representing the soundbank.
  51      * @return soundbank object
  52      * @throws InvalidMidiDataException if the URL does not point to valid MIDI
  53      *         soundbank data recognized by this soundbank reader
  54      * @throws IOException if an I/O error occurs
  55      */
  56     public abstract Soundbank getSoundbank(URL url)
  57             throws InvalidMidiDataException, IOException;
  58 
  59     /**
  60      * Obtains a soundbank object from the {@code InputStream} provided.
  61      *
  62      * @param  stream {@code InputStream} representing the soundbank
  63      * @return soundbank object
  64      * @throws InvalidMidiDataException if the stream does not point to valid
  65      *         MIDI soundbank data recognized by this soundbank reader
  66      * @throws IOException if an I/O error occurs
  67      */
  68     public abstract Soundbank getSoundbank(InputStream stream)
  69             throws InvalidMidiDataException, IOException;
  70 
  71     /**
  72      * Obtains a soundbank object from the {@code File} provided.
  73      *
  74      * @param  file the {@code File} representing the soundbank
  75      * @return soundbank object
  76      * @throws InvalidMidiDataException if the file does not point to valid MIDI
  77      *         soundbank data recognized by this soundbank reader
  78      * @throws IOException if an I/O error occurs
  79      */
  80     public abstract Soundbank getSoundbank(File file)
  81             throws InvalidMidiDataException, IOException;
  82 }
--- EOF ---