Class MidiFileReader

java.lang.Object
javax.sound.midi.spi.MidiFileReader
public abstract class MidiFileReader extends Object
A MidiFileReader supplies MIDI file-reading services. Classes implementing this interface can parse the format information from one or more types of MIDI file, and can produce a Sequence object from files of these types.
Since:
1.3

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    MidiFileReader()
    Constructor for subclasses to call.

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract MidiFileFormat
    getMidiFileFormat(File file)
    Obtains the MIDI file format of the File provided.
    abstract MidiFileFormat
    getMidiFileFormat(InputStream stream)
    Obtains the MIDI file format of the input stream provided.
    abstract MidiFileFormat
    getMidiFileFormat(URL url)
    Obtains the MIDI file format of the URL provided.
    abstract Sequence
    getSequence(File file)
    Obtains a MIDI sequence from the File provided.
    abstract Sequence
    getSequence(InputStream stream)
    Obtains a MIDI sequence from the input stream provided.
    abstract Sequence
    getSequence(URL url)
    Obtains a MIDI sequence from the URL provided.

    Methods declared in class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    Modifier and Type
    Method
    Description
    protected Object
    clone()
    Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
    boolean
    equals(Object o)
    Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
    protected void
    finalize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    May cause performance issues, deadlocks and hangs.
    final Class<? extends Object>
    getClass()
    Answers the unique instance of java.lang.Class which represents the class of the receiver.
    int
    hashCode()
    Answers an integer hash code for the receiver.
    final void
    notify()
    Causes one thread which is waiting on the receiver to be made ready to run.
    final void
    notifyAll()
    Causes all threads which are waiting on the receiver to be made ready to run.
    String
    toString()
    Answers a string containing a concise, human-readable description of the receiver.
    final void
    wait()
    Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
    final void
    wait(long time)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
    final void
    wait(long time, int frac)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

  • Constructor Details

    • MidiFileReader

      protected MidiFileReader()
      Constructor for subclasses to call.

  • Method Details

    • getMidiFileFormat

      public abstract MidiFileFormat getMidiFileFormat(InputStream stream) throws InvalidMidiDataException, IOException
      Obtains the MIDI file format of the input stream provided. The stream must point to valid MIDI file data. In general, MIDI file readers may need to read some data from the stream before determining whether they support it. These parsers must be able to mark the stream, read enough data to determine whether they support the stream, and, if not, reset the stream's read pointer to its original position. If the input stream does not support this, this method may fail with an IOException.
      Parameters:
      stream - the input stream from which file format information should be extracted
      Returns:
      a MidiFileFormat object describing the MIDI file format
      Throws:
      InvalidMidiDataException - if the stream does not point to valid MIDI file data recognized by the system
      IOException - if an I/O exception occurs
      NullPointerException - if stream is null
      See Also:

    • getMidiFileFormat

      public abstract MidiFileFormat getMidiFileFormat(URL url) throws InvalidMidiDataException, IOException
      Obtains the MIDI file format of the URL provided. The URL must point to valid MIDI file data.
      Parameters:
      url - the URL from which file format information should be extracted
      Returns:
      a MidiFileFormat object describing the MIDI file format
      Throws:
      InvalidMidiDataException - if the URL does not point to valid MIDI file data recognized by the system
      IOException - if an I/O exception occurs
      NullPointerException - if url is null

    • getMidiFileFormat

      public abstract MidiFileFormat getMidiFileFormat(File file) throws InvalidMidiDataException, IOException
      Obtains the MIDI file format of the File provided. The File must point to valid MIDI file data.
      Parameters:
      file - the File from which file format information should be extracted
      Returns:
      a MidiFileFormat object describing the MIDI file format
      Throws:
      InvalidMidiDataException - if the File does not point to valid MIDI file data recognized by the system
      IOException - if an I/O exception occurs
      NullPointerException - if file is null

    • getSequence

      public abstract Sequence getSequence(InputStream stream) throws InvalidMidiDataException, IOException
      Obtains a MIDI sequence from the input stream provided. The stream must point to valid MIDI file data. In general, MIDI file readers may need to read some data from the stream before determining whether they support it. These parsers must be able to mark the stream, read enough data to determine whether they support the stream, and, if not, reset the stream's read pointer to its original position. If the input stream does not support this, this method may fail with an IOException.
      Parameters:
      stream - the input stream from which the Sequence should be constructed
      Returns:
      a Sequence object based on the MIDI file data contained in the input stream
      Throws:
      InvalidMidiDataException - if the stream does not point to valid MIDI file data recognized by the system
      IOException - if an I/O exception occurs
      NullPointerException - if stream is null
      See Also:

    • getSequence

      public abstract Sequence getSequence(URL url) throws InvalidMidiDataException, IOException
      Obtains a MIDI sequence from the URL provided. The URL must point to valid MIDI file data.
      Parameters:
      url - the URL for which the Sequence should be constructed
      Returns:
      a Sequence object based on the MIDI file data pointed to by the URL
      Throws:
      InvalidMidiDataException - if the URL does not point to valid MIDI file data recognized by the system
      IOException - if an I/O exception occurs
      NullPointerException - if url is null

    • getSequence

      public abstract Sequence getSequence(File file) throws InvalidMidiDataException, IOException
      Obtains a MIDI sequence from the File provided. The File must point to valid MIDI file data.
      Parameters:
      file - the File from which the Sequence should be constructed
      Returns:
      a Sequence object based on the MIDI file data pointed to by the File
      Throws:
      InvalidMidiDataException - if the File does not point to valid MIDI file data recognized by the system
      IOException - if an I/O exception occurs
      NullPointerException - if file is null