author | ddehaven |
Tue, 19 Aug 2014 10:32:16 -0700 | |
changeset 26037 | 508779ce6619 |
parent 26003 | jdk/src/share/classes/javax/sound/midi/spi/MidiFileReader.java@d630c97424bd |
parent 25859 | jdk/src/share/classes/javax/sound/midi/spi/MidiFileReader.java@3317bb8137f4 |
child 34806 | 65f9c9d7b623 |
permissions | -rw-r--r-- |
2 | 1 |
/* |
23688
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
2 |
* Copyright (c) 1999, 2014, Oracle and/or its affiliates. All rights reserved. |
2 | 3 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
4 |
* |
|
5 |
* This code is free software; you can redistribute it and/or modify it |
|
6 |
* under the terms of the GNU General Public License version 2 only, as |
|
5506 | 7 |
* published by the Free Software Foundation. Oracle designates this |
2 | 8 |
* particular file as subject to the "Classpath" exception as provided |
5506 | 9 |
* by Oracle in the LICENSE file that accompanied this code. |
2 | 10 |
* |
11 |
* This code is distributed in the hope that it will be useful, but WITHOUT |
|
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
13 |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
14 |
* version 2 for more details (a copy is included in the LICENSE file that |
|
15 |
* accompanied this code). |
|
16 |
* |
|
17 |
* You should have received a copy of the GNU General Public License version |
|
18 |
* 2 along with this work; if not, write to the Free Software Foundation, |
|
19 |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
|
20 |
* |
|
5506 | 21 |
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
22 |
* or visit www.oracle.com if you need additional information or have any |
|
23 |
* questions. |
|
2 | 24 |
*/ |
25 |
||
26 |
package javax.sound.midi.spi; |
|
27 |
||
28 |
import java.io.File; |
|
26003
d630c97424bd
8050852: Javadoc cleanup of javax.sound.midi package
serb
parents:
23688
diff
changeset
|
29 |
import java.io.IOException; |
2 | 30 |
import java.io.InputStream; |
31 |
import java.net.URL; |
|
32 |
||
26003
d630c97424bd
8050852: Javadoc cleanup of javax.sound.midi package
serb
parents:
23688
diff
changeset
|
33 |
import javax.sound.midi.InvalidMidiDataException; |
2 | 34 |
import javax.sound.midi.MidiFileFormat; |
35 |
import javax.sound.midi.Sequence; |
|
36 |
||
37 |
/** |
|
23688
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
38 |
* A {@code MidiFileReader} supplies MIDI file-reading services. Classes |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
39 |
* implementing this interface can parse the format information from one or more |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
40 |
* types of MIDI file, and can produce a {@link Sequence} object from files of |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
41 |
* these types. |
2 | 42 |
* |
43 |
* @author Kara Kytle |
|
44 |
* @since 1.3 |
|
45 |
*/ |
|
46 |
public abstract class MidiFileReader { |
|
47 |
||
48 |
/** |
|
23688
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
49 |
* Obtains the MIDI file format of the input stream provided. The stream |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
50 |
* must point to valid MIDI file data. In general, MIDI file readers may |
2 | 51 |
* need to read some data from the stream before determining whether they |
23688
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
52 |
* support it. These parsers must be able to mark the stream, read enough |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
53 |
* data to determine whether they support the stream, and, if not, reset the |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
54 |
* stream's read pointer to its original position. If the input stream does |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
55 |
* not support this, this method may fail with an {@code IOException}. |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
56 |
* |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
57 |
* @param stream the input stream from which file format information |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
58 |
* should be extracted |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
59 |
* @return a {@code MidiFileFormat} object describing the MIDI file format |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
60 |
* @throws InvalidMidiDataException if the stream does not point to valid |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
61 |
* MIDI file data recognized by the system |
2 | 62 |
* @throws IOException if an I/O exception occurs |
63 |
* @see InputStream#markSupported |
|
64 |
* @see InputStream#mark |
|
65 |
*/ |
|
23688
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
66 |
public abstract MidiFileFormat getMidiFileFormat(InputStream stream) |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
67 |
throws InvalidMidiDataException, IOException; |
2 | 68 |
|
69 |
/** |
|
23688
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
70 |
* Obtains the MIDI file format of the URL provided. The URL must point to |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
71 |
* valid MIDI file data. |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
72 |
* |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
73 |
* @param url the URL from which file format information should be |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
74 |
* extracted |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
75 |
* @return a {@code MidiFileFormat} object describing the MIDI file format |
2 | 76 |
* @throws InvalidMidiDataException if the URL does not point to valid MIDI |
23688
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
77 |
* file data recognized by the system |
2 | 78 |
* @throws IOException if an I/O exception occurs |
79 |
*/ |
|
23688
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
80 |
public abstract MidiFileFormat getMidiFileFormat(URL url) |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
81 |
throws InvalidMidiDataException, IOException; |
2 | 82 |
|
83 |
/** |
|
23688
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
84 |
* Obtains the MIDI file format of the {@code File} provided. The |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
85 |
* {@code File} must point to valid MIDI file data. |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
86 |
* |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
87 |
* @param file the {@code File} from which file format information should |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
88 |
* be extracted |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
89 |
* @return a {@code MidiFileFormat} object describing the MIDI file format |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
90 |
* @throws InvalidMidiDataException if the {@code File} does not point to |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
91 |
* valid MIDI file data recognized by the system |
2 | 92 |
* @throws IOException if an I/O exception occurs |
93 |
*/ |
|
23688
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
94 |
public abstract MidiFileFormat getMidiFileFormat(File file) |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
95 |
throws InvalidMidiDataException, IOException; |
2 | 96 |
|
97 |
/** |
|
23688
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
98 |
* Obtains a MIDI sequence from the input stream provided. The stream must |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
99 |
* point to valid MIDI file data. In general, MIDI file readers may need to |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
100 |
* read some data from the stream before determining whether they support |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
101 |
* it. These parsers must be able to mark the stream, read enough data to |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
102 |
* determine whether they support the stream, and, if not, reset the |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
103 |
* stream's read pointer to its original position. If the input stream does |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
104 |
* not support this, this method may fail with an IOException. |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
105 |
* |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
106 |
* @param stream the input stream from which the {@code Sequence} should |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
107 |
* be constructed |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
108 |
* @return a {@code Sequence} object based on the MIDI file data contained |
26003
d630c97424bd
8050852: Javadoc cleanup of javax.sound.midi package
serb
parents:
23688
diff
changeset
|
109 |
* in the input stream |
23688
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
110 |
* @throws InvalidMidiDataException if the stream does not point to valid |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
111 |
* MIDI file data recognized by the system |
2 | 112 |
* @throws IOException if an I/O exception occurs |
113 |
* @see InputStream#markSupported |
|
114 |
* @see InputStream#mark |
|
115 |
*/ |
|
23688
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
116 |
public abstract Sequence getSequence(InputStream stream) |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
117 |
throws InvalidMidiDataException, IOException; |
2 | 118 |
|
119 |
/** |
|
23688
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
120 |
* Obtains a MIDI sequence from the URL provided. The URL must point to |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
121 |
* valid MIDI file data. |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
122 |
* |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
123 |
* @param url the URL for which the {@code Sequence} should be constructed |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
124 |
* @return a {@code Sequence} object based on the MIDI file data pointed to |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
125 |
* by the URL |
2 | 126 |
* @throws InvalidMidiDataException if the URL does not point to valid MIDI |
23688
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
127 |
* file data recognized by the system |
2 | 128 |
* @throws IOException if an I/O exception occurs |
129 |
*/ |
|
23688
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
130 |
public abstract Sequence getSequence(URL url) |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
131 |
throws InvalidMidiDataException, IOException; |
2 | 132 |
|
133 |
/** |
|
23688
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
134 |
* Obtains a MIDI sequence from the {@code File} provided. The {@code File} |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
135 |
* must point to valid MIDI file data. |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
136 |
* |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
137 |
* @param file the {@code File} from which the {@code Sequence} should be |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
138 |
* constructed |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
139 |
* @return a {@code Sequence} object based on the MIDI file data pointed to |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
140 |
* by the {@code File} |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
141 |
* @throws InvalidMidiDataException if the {@code File} does not point to |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
142 |
* valid MIDI file data recognized by the system |
2 | 143 |
* @throws IOException if an I/O exception occurs |
144 |
*/ |
|
23688
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
145 |
public abstract Sequence getSequence(File file) |
6781b500dfca
8037117: Javadoc cleanup of javax.sound.midi.spi package
serb
parents:
5506
diff
changeset
|
146 |
throws InvalidMidiDataException, IOException; |
2 | 147 |
} |