001    /* MidiFilerReader.java -- MIDI 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.MidiFileFormat;
048    import javax.sound.midi.Sequence;
049    
050    /**
051     * The MidiFileReader abstract class defines the methods to be provided
052     * by a MIDI file reader.
053     *
054     * @author Anthony Green (green@redhat.com)
055     * @since 1.3
056     *
057     */
058    public abstract class MidiFileReader
059    {
060      /**
061       * Read a MidiFileFormat from the given stream.
062       *
063       * @param stream the stream from which to read the MIDI data
064       * @return the MidiFileFormat object
065       * @throws InvalidMidiDataException if the stream refers to invalid data
066       * @throws IOException if an I/O exception occurs while reading
067       */
068      public abstract MidiFileFormat getMidiFileFormat(InputStream stream)
069        throws InvalidMidiDataException, IOException;
070    
071      /**
072       * Read a MidiFileFormat from the given stream.
073       *
074       * @param url the url from which to read the MIDI data
075       * @return the MidiFileFormat object
076       * @throws InvalidMidiDataException if the url refers to invalid data
077       * @throws IOException if an I/O exception occurs while reading
078       */
079      public abstract MidiFileFormat getMidiFileFormat(URL url)
080        throws InvalidMidiDataException, IOException;
081    
082      /**
083       * Read a MidiFileFormat from the given stream.
084       *
085       * @param file the file from which to read the MIDI data
086       * @return the MidiFileFormat object
087       * @throws InvalidMidiDataException if the file refers to invalid data
088       * @throws IOException if an I/O exception occurs while reading
089       */
090      public abstract MidiFileFormat getMidiFileFormat(File file)
091        throws InvalidMidiDataException, IOException;
092    
093      /**
094       * Read a Sequence from the given stream.
095       *
096       * @param stream the stream from which to read the MIDI data
097       * @return the Sequence object
098       * @throws InvalidMidiDataException if the stream refers to invalid data
099       * @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    }