001    /* SoundbankReader.java -- Soundbank file reading services
002       Copyright (C) 2005 Free Software Foundation, Inc.
003    
004    This file is part of GNU Classpath.
005    
006    GNU Classpath is free software; you can redistribute it and/or modify
007    it under the terms of the GNU General Public License as published by
008    the Free Software Foundation; either version 2, or (at your option)
009    any later version.
010    
011    GNU Classpath is distributed in the hope that it will be useful, but
012    WITHOUT ANY WARRANTY; without even the implied warranty of
013    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014    General Public License for more details.
015    
016    You should have received a copy of the GNU General Public License
017    along with GNU Classpath; see the file COPYING.  If not, write to the
018    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019    02110-1301 USA.
020    
021    Linking this library statically or dynamically with other modules is
022    making a combined work based on this library.  Thus, the terms and
023    conditions of the GNU General Public License cover the whole
024    combination.
025    
026    As a special exception, the copyright holders of this library give you
027    permission to link this library with independent modules to produce an
028    executable, regardless of the license terms of these independent
029    modules, and to copy and distribute the resulting executable under
030    terms of your choice, provided that you also meet, for each linked
031    independent module, the terms and conditions of the license of that
032    module.  An independent module is a module which is not derived from
033    or based on this library.  If you modify this library, you may extend
034    this exception to your version of the library, but you are not
035    obligated to do so.  If you do not wish to do so, delete this
036    exception statement from your version. */
037    
038    
039    package javax.sound.midi.spi;
040    
041    import java.io.File;
042    import java.io.IOException;
043    import java.io.InputStream;
044    import java.net.URL;
045    
046    import javax.sound.midi.InvalidMidiDataException;
047    import javax.sound.midi.Soundbank;
048    
049    /**
050     * The SoundbankReader abstract class defines the methods to be provided
051     * by a soundbank file reader.
052     * 
053     * @author Anthony Green (green@redhat.com)
054     * @since 1.3
055     *
056     */
057    public abstract class SoundbankReader
058    {
059      /**
060       * Get a Soundbank from the given URL.
061       * 
062       * @param url from which to read the Soundbank
063       * 
064       * @return the Soundbank object
065       * 
066       * @throws InvalidMidiDataException if the data provided by url cannot be recognized
067       * @throws IOException if the data provided by url cannot be read
068       */
069      public abstract Soundbank getSoundbank(URL url)
070        throws InvalidMidiDataException, IOException;
071      
072      /**
073       * Get a Soundbank from the given InputStream.
074       * 
075       * @param stream from which to read the Soundbank
076       * 
077       * @return the Soundbank object
078       * 
079       * @throws InvalidMidiDataException if the data provided by InputStream cannot be recognized
080       * @throws IOException if the data provided by InputStream cannot be read
081       */
082      public abstract Soundbank getSoundbank(InputStream stream)
083        throws InvalidMidiDataException, IOException;
084      
085      /**
086       * Get a Soundbank from the given File.
087       * 
088       * @param file from which to read the Soundbank
089       * 
090       * @return the Soundbank object
091       * 
092       * @throws InvalidMidiDataException if the data provided by File cannot be recognized
093       * @throws IOException if the data provided by File cannot be read
094       */
095      public abstract Soundbank getSoundbank(File file)
096        throws InvalidMidiDataException, IOException;
097    }