Source for javax.sound.midi.spi.SoundbankReader

   1: /* SoundbankReader.java -- Soundbank file reading services
   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 java.io.File;
  42: import java.io.IOException;
  43: import java.io.InputStream;
  44: import java.net.URL;
  45: 
  46: import javax.sound.midi.InvalidMidiDataException;
  47: import javax.sound.midi.Soundbank;
  48: 
  49: /**
  50:  * The SoundbankReader abstract class defines the methods to be provided
  51:  * by a soundbank file reader.
  52:  * 
  53:  * @author Anthony Green (green@redhat.com)
  54:  * @since 1.3
  55:  *
  56:  */
  57: public abstract class SoundbankReader
  58: {
  59:   /**
  60:    * Get a Soundbank from the given URL.
  61:    * 
  62:    * @param url from which to read the Soundbank
  63:    * 
  64:    * @return the Soundbank object
  65:    * 
  66:    * @throws InvalidMidiDataException if the data provided by url cannot be recognized
  67:    * @throws IOException if the data provided by url cannot be read
  68:    */
  69:   public abstract Soundbank getSoundbank(URL url)
  70:     throws InvalidMidiDataException, IOException;
  71:   
  72:   /**
  73:    * Get a Soundbank from the given InputStream.
  74:    * 
  75:    * @param stream from which to read the Soundbank
  76:    * 
  77:    * @return the Soundbank object
  78:    * 
  79:    * @throws InvalidMidiDataException if the data provided by InputStream cannot be recognized
  80:    * @throws IOException if the data provided by InputStream cannot be read
  81:    */
  82:   public abstract Soundbank getSoundbank(InputStream stream)
  83:     throws InvalidMidiDataException, IOException;
  84:   
  85:   /**
  86:    * Get a Soundbank from the given File.
  87:    * 
  88:    * @param file from which to read the Soundbank
  89:    * 
  90:    * @return the Soundbank object
  91:    * 
  92:    * @throws InvalidMidiDataException if the data provided by File cannot be recognized
  93:    * @throws IOException if the data provided by File cannot be read
  94:    */
  95:   public abstract Soundbank getSoundbank(File file)
  96:     throws InvalidMidiDataException, IOException;
  97: }