Source for javax.sound.midi.spi.MidiFileReader

   1: /* MidiFilerReader.java -- MIDI 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.MidiFileFormat;
  48: import javax.sound.midi.Sequence;
  49: 
  50: /**
  51:  * The MidiFileReader abstract class defines the methods to be provided
  52:  * by a MIDI file reader.
  53:  * 
  54:  * @author Anthony Green (green@redhat.com)
  55:  * @since 1.3
  56:  *
  57:  */
  58: public abstract class MidiFileReader
  59: {
  60:   /**
  61:    * Read a MidiFileFormat from the given stream.
  62:    * 
  63:    * @param stream the stream from which to read the MIDI data
  64:    * @return the MidiFileFormat object
  65:    * @throws InvalidMidiDataException if the stream refers to invalid data
  66:    * @throws IOException if an I/O exception occurs while reading
  67:    */
  68:   public abstract MidiFileFormat getMidiFileFormat(InputStream stream)
  69:     throws InvalidMidiDataException, IOException;
  70:   
  71:   /**
  72:    * Read a MidiFileFormat from the given stream.
  73:    * 
  74:    * @param url the url from which to read the MIDI data
  75:    * @return the MidiFileFormat object
  76:    * @throws InvalidMidiDataException if the url refers to invalid data
  77:    * @throws IOException if an I/O exception occurs while reading
  78:    */
  79:   public abstract MidiFileFormat getMidiFileFormat(URL url)
  80:     throws InvalidMidiDataException, IOException;  
  81: 
  82:   /**
  83:    * Read a MidiFileFormat from the given stream.
  84:    * 
  85:    * @param file the file from which to read the MIDI data
  86:    * @return the MidiFileFormat object
  87:    * @throws InvalidMidiDataException if the file refers to invalid data
  88:    * @throws IOException if an I/O exception occurs while reading
  89:    */
  90:   public abstract MidiFileFormat getMidiFileFormat(File file)
  91:     throws InvalidMidiDataException, IOException; 
  92:   
  93:   /**
  94:    * Read a Sequence from the given stream.
  95:    * 
  96:    * @param stream the stream from which to read the MIDI data
  97:    * @return the Sequence object
  98:    * @throws InvalidMidiDataException if the stream refers to invalid data
  99:    * @throws IOException if an I/O exception occurs while reading
 100:    */
 101:   public abstract Sequence getSequence(InputStream stream)
 102:     throws InvalidMidiDataException, IOException;
 103:   
 104:   /**
 105:    * Read a Sequence from the given stream.
 106:    * 
 107:    * @param url the url from which to read the MIDI data
 108:    * @return the Sequence object
 109:    * @throws InvalidMidiDataException if the url refers to invalid data
 110:    * @throws IOException if an I/O exception occurs while reading
 111:    */
 112:   public abstract Sequence getSequence(URL url)
 113:     throws InvalidMidiDataException, IOException;  
 114: 
 115:   /**
 116:    * Read a Sequence from the given stream.
 117:    * 
 118:    * @param file the file from which to read the MIDI data
 119:    * @return the Sequence object
 120:    * @throws InvalidMidiDataException if the file refers to invalid data
 121:    * @throws IOException if an I/O exception occurs while reading
 122:    */
 123:   public abstract Sequence getSequence(File file)
 124:     throws InvalidMidiDataException, IOException; 
 125: }