--- a/jdk/src/share/classes/javax/sound/midi/spi/MidiFileReader.java Fri Mar 21 16:32:26 2014 +0400
+++ b/jdk/src/share/classes/javax/sound/midi/spi/MidiFileReader.java Fri Mar 21 16:51:53 2014 +0400
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1999, 2002, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1999, 2014, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -35,9 +35,10 @@
import javax.sound.midi.InvalidMidiDataException;
/**
- * A <code>MidiFileReader</code> 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 <code>Sequence</code> object from files of these types.
+ * A {@code 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 {@link Sequence} object from files of
+ * these types.
*
* @author Kara Kytle
* @since 1.3
@@ -45,98 +46,102 @@
public abstract class MidiFileReader {
/**
- * 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
+ * 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 <code>IOException</code>.
- * @param stream the input stream from which file format information should be
- * extracted
- * @return a <code>MidiFileFormat</code> object describing the MIDI file format
- * @throws InvalidMidiDataException if the stream does not point to valid MIDI
- * file data recognized by the system
+ * 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 {@code IOException}.
+ *
+ * @param stream the input stream from which file format information
+ * should be extracted
+ * @return a {@code MidiFileFormat} object describing the MIDI file format
+ * @throws InvalidMidiDataException if the stream does not point to valid
+ * MIDI file data recognized by the system
* @throws IOException if an I/O exception occurs
* @see InputStream#markSupported
* @see InputStream#mark
*/
- public abstract MidiFileFormat getMidiFileFormat(InputStream stream) throws InvalidMidiDataException, IOException;
-
+ public abstract MidiFileFormat getMidiFileFormat(InputStream stream)
+ throws InvalidMidiDataException, IOException;
/**
- * Obtains the MIDI file format of the URL provided. The URL must
- * point to valid MIDI file data.
- * @param url the URL from which file format information should be
- * extracted
- * @return a <code>MidiFileFormat</code> object describing the MIDI file format
+ * Obtains the MIDI file format of the URL provided. The URL must point to
+ * valid MIDI file data.
+ *
+ * @param url the URL from which file format information should be
+ * extracted
+ * @return a {@code MidiFileFormat} object describing the MIDI file format
* @throws InvalidMidiDataException if the URL does not point to valid MIDI
- * file data recognized by the system
+ * file data recognized by the system
* @throws IOException if an I/O exception occurs
*/
- public abstract MidiFileFormat getMidiFileFormat(URL url) throws InvalidMidiDataException, IOException;
-
+ public abstract MidiFileFormat getMidiFileFormat(URL url)
+ throws InvalidMidiDataException, IOException;
/**
- * Obtains the MIDI file format of the <code>File</code> provided.
- * The <code>File</code> must point to valid MIDI file data.
- * @param file the <code>File</code> from which file format information should be
- * extracted
- * @return a <code>MidiFileFormat</code> object describing the MIDI file format
- * @throws InvalidMidiDataException if the <code>File</code> does not point to valid MIDI
- * file data recognized by the system
+ * Obtains the MIDI file format of the {@code File} provided. The
+ * {@code File} must point to valid MIDI file data.
+ *
+ * @param file the {@code File} from which file format information should
+ * be extracted
+ * @return a {@code MidiFileFormat} object describing the MIDI file format
+ * @throws InvalidMidiDataException if the {@code File} does not point to
+ * valid MIDI file data recognized by the system
* @throws IOException if an I/O exception occurs
*/
- public abstract MidiFileFormat getMidiFileFormat(File file) throws InvalidMidiDataException, IOException;
-
+ public abstract MidiFileFormat getMidiFileFormat(File file)
+ 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.
- * @param stream the input stream from which the <code>Sequence</code> should be
- * constructed
- * @return a <code>Sequence</code> 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
+ * 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.
+ *
+ * @param stream the input stream from which the {@code Sequence} should
+ * be constructed
+ * @return a {@code 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
* @throws IOException if an I/O exception occurs
* @see InputStream#markSupported
* @see InputStream#mark
*/
- public abstract Sequence getSequence(InputStream stream) throws InvalidMidiDataException, IOException;
-
+ public abstract Sequence getSequence(InputStream stream)
+ throws InvalidMidiDataException, IOException;
/**
- * Obtains a MIDI sequence from the URL provided. The URL must
- * point to valid MIDI file data.
- * @param url the URL for which the <code>Sequence</code> should be
- * constructed
- * @return a <code>Sequence</code> object based on the MIDI file data pointed
- * to by the URL
+ * Obtains a MIDI sequence from the URL provided. The URL must point to
+ * valid MIDI file data.
+ *
+ * @param url the URL for which the {@code Sequence} should be constructed
+ * @return a {@code 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
+ * file data recognized by the system
* @throws IOException if an I/O exception occurs
*/
- public abstract Sequence getSequence(URL url) throws InvalidMidiDataException, IOException;
-
+ public abstract Sequence getSequence(URL url)
+ throws InvalidMidiDataException, IOException;
/**
- * Obtains a MIDI sequence from the <code>File</code> provided. The <code>File</code> must
- * point to valid MIDI file data.
- * @param file the <code>File</code> from which the <code>Sequence</code> should be
- * constructed
- * @return a <code>Sequence</code> object based on the MIDI file data pointed
- * to by the <code>File</code>
- * @throws InvalidMidiDataException if the <code>File</code> does not point to valid MIDI
- * file data recognized by the system
+ * Obtains a MIDI sequence from the {@code File} provided. The {@code File}
+ * must point to valid MIDI file data.
+ *
+ * @param file the {@code File} from which the {@code Sequence} should be
+ * constructed
+ * @return a {@code Sequence} object based on the MIDI file data pointed to
+ * by the {@code File}
+ * @throws InvalidMidiDataException if the {@code File} does not point to
+ * valid MIDI file data recognized by the system
* @throws IOException if an I/O exception occurs
*/
- public abstract Sequence getSequence(File file) throws InvalidMidiDataException, IOException;
+ public abstract Sequence getSequence(File file)
+ throws InvalidMidiDataException, IOException;
}