0N/A/*
2362N/A * Copyright (c) 1999, 2002, Oracle and/or its affiliates. All rights reserved.
0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
0N/A *
0N/A * This code is free software; you can redistribute it and/or modify it
0N/A * under the terms of the GNU General Public License version 2 only, as
2362N/A * published by the Free Software Foundation. Oracle designates this
0N/A * particular file as subject to the "Classpath" exception as provided
2362N/A * by Oracle in the LICENSE file that accompanied this code.
0N/A *
0N/A * This code is distributed in the hope that it will be useful, but WITHOUT
0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
0N/A * version 2 for more details (a copy is included in the LICENSE file that
0N/A * accompanied this code).
0N/A *
0N/A * You should have received a copy of the GNU General Public License version
0N/A * 2 along with this work; if not, write to the Free Software Foundation,
0N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
0N/A *
2362N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
2362N/A * or visit www.oracle.com if you need additional information or have any
2362N/A * questions.
0N/A */
0N/A
0N/Apackage javax.sound.midi.spi;
0N/A
0N/Aimport java.io.File;
0N/Aimport java.io.InputStream;
0N/Aimport java.io.IOException;
0N/Aimport java.net.URL;
0N/A
0N/Aimport javax.sound.midi.MidiFileFormat;
0N/Aimport javax.sound.midi.Sequence;
0N/Aimport javax.sound.midi.InvalidMidiDataException;
0N/A
0N/A/**
0N/A * A <code>MidiFileReader</code> supplies MIDI file-reading services. Classes implementing this
0N/A * interface can parse the format information from one or more types of
0N/A * MIDI file, and can produce a <code>Sequence</code> object from files of these types.
0N/A *
0N/A * @author Kara Kytle
0N/A * @since 1.3
0N/A */
0N/Apublic abstract class MidiFileReader {
0N/A
0N/A /**
0N/A * Obtains the MIDI file format of the input stream provided. The stream must
0N/A * point to valid MIDI file data. In general, MIDI file readers may
0N/A * need to read some data from the stream before determining whether they
0N/A * support it. These parsers must
0N/A * be able to mark the stream, read enough data to determine whether they
0N/A * support the stream, and, if not, reset the stream's read pointer to its original
0N/A * position. If the input stream does not support this, this method may fail
0N/A * with an <code>IOException</code>.
0N/A * @param stream the input stream from which file format information should be
0N/A * extracted
0N/A * @return a <code>MidiFileFormat</code> object describing the MIDI file format
0N/A * @throws InvalidMidiDataException if the stream does not point to valid MIDI
0N/A * file data recognized by the system
0N/A * @throws IOException if an I/O exception occurs
0N/A * @see InputStream#markSupported
0N/A * @see InputStream#mark
0N/A */
0N/A public abstract MidiFileFormat getMidiFileFormat(InputStream stream) throws InvalidMidiDataException, IOException;
0N/A
0N/A
0N/A /**
0N/A * Obtains the MIDI file format of the URL provided. The URL must
0N/A * point to valid MIDI file data.
0N/A * @param url the URL from which file format information should be
0N/A * extracted
0N/A * @return a <code>MidiFileFormat</code> object describing the MIDI file format
0N/A * @throws InvalidMidiDataException if the URL does not point to valid MIDI
0N/A * file data recognized by the system
0N/A * @throws IOException if an I/O exception occurs
0N/A */
0N/A public abstract MidiFileFormat getMidiFileFormat(URL url) throws InvalidMidiDataException, IOException;
0N/A
0N/A
0N/A /**
0N/A * Obtains the MIDI file format of the <code>File</code> provided.
0N/A * The <code>File</code> must point to valid MIDI file data.
0N/A * @param file the <code>File</code> from which file format information should be
0N/A * extracted
0N/A * @return a <code>MidiFileFormat</code> object describing the MIDI file format
0N/A * @throws InvalidMidiDataException if the <code>File</code> does not point to valid MIDI
0N/A * file data recognized by the system
0N/A * @throws IOException if an I/O exception occurs
0N/A */
0N/A public abstract MidiFileFormat getMidiFileFormat(File file) throws InvalidMidiDataException, IOException;
0N/A
0N/A
0N/A /**
0N/A * Obtains a MIDI sequence from the input stream provided. The stream must
0N/A * point to valid MIDI file data. In general, MIDI file readers may
0N/A * need to read some data from the stream before determining whether they
0N/A * support it. These parsers must
0N/A * be able to mark the stream, read enough data to determine whether they
0N/A * support the stream, and, if not, reset the stream's read pointer to its original
0N/A * position. If the input stream does not support this, this method may fail
0N/A * with an IOException.
0N/A * @param stream the input stream from which the <code>Sequence</code> should be
0N/A * constructed
0N/A * @return a <code>Sequence</code> object based on the MIDI file data contained
0N/A * in the input stream.
0N/A * @throws InvalidMidiDataException if the stream does not point to valid MIDI
0N/A * file data recognized by the system
0N/A * @throws IOException if an I/O exception occurs
0N/A * @see InputStream#markSupported
0N/A * @see InputStream#mark
0N/A */
0N/A public abstract Sequence getSequence(InputStream stream) throws InvalidMidiDataException, IOException;
0N/A
0N/A
0N/A /**
0N/A * Obtains a MIDI sequence from the URL provided. The URL must
0N/A * point to valid MIDI file data.
0N/A * @param url the URL for which the <code>Sequence</code> should be
0N/A * constructed
0N/A * @return a <code>Sequence</code> object based on the MIDI file data pointed
0N/A * to by the URL
0N/A * @throws InvalidMidiDataException if the URL does not point to valid MIDI
0N/A * file data recognized by the system
0N/A * @throws IOException if an I/O exception occurs
0N/A */
0N/A public abstract Sequence getSequence(URL url) throws InvalidMidiDataException, IOException;
0N/A
0N/A
0N/A /**
0N/A * Obtains a MIDI sequence from the <code>File</code> provided. The <code>File</code> must
0N/A * point to valid MIDI file data.
0N/A * @param file the <code>File</code> from which the <code>Sequence</code> should be
0N/A * constructed
0N/A * @return a <code>Sequence</code> object based on the MIDI file data pointed
0N/A * to by the <code>File</code>
0N/A * @throws InvalidMidiDataException if the <code>File</code> does not point to valid MIDI
0N/A * file data recognized by the system
0N/A * @throws IOException if an I/O exception occurs
0N/A */
0N/A public abstract Sequence getSequence(File file) throws InvalidMidiDataException, IOException;
0N/A}