< prev index next >

src/java.desktop/share/classes/javax/sound/midi/spi/MidiFileWriter.java

Print this page


   1 /*
   2  * Copyright (c) 1999, 2018, Oracle and/or its affiliates. All rights reserved.
   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
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  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  *
  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


  24  */
  25 
  26 package javax.sound.midi.spi;
  27 
  28 import java.io.File;
  29 import java.io.IOException;
  30 import java.io.OutputStream;
  31 import java.util.Arrays;
  32 
  33 import javax.sound.midi.Sequence;
  34 
  35 /**
  36  * A {@code MidiFileWriter} supplies MIDI file-writing services. Classes that
  37  * implement this interface can write one or more types of MIDI file from a
  38  * {@link Sequence} object.
  39  *
  40  * @author Kara Kytle
  41  * @since 1.3
  42  */
  43 public abstract class MidiFileWriter {





  44 
  45     /**
  46      * Obtains the set of MIDI file types for which file writing support is
  47      * provided by this file writer.
  48      *
  49      * @return array of file types. If no file types are supported, an array of
  50      *         length 0 is returned.
  51      */
  52     public abstract int[] getMidiFileTypes();
  53 
  54     /**
  55      * Obtains the file types that this file writer can write from the sequence
  56      * specified.
  57      *
  58      * @param  sequence the sequence for which MIDI file type support is queried
  59      * @return array of file types. If no file types are supported, returns an
  60      *         array of length 0.
  61      * @throws NullPointerException if {@code sequence} is {@code null}
  62      */
  63     public abstract int[] getMidiFileTypes(Sequence sequence);


   1 /*
   2  * Copyright (c) 1999, 2020, Oracle and/or its affiliates. All rights reserved.
   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
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  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  *
  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


  24  */
  25 
  26 package javax.sound.midi.spi;
  27 
  28 import java.io.File;
  29 import java.io.IOException;
  30 import java.io.OutputStream;
  31 import java.util.Arrays;
  32 
  33 import javax.sound.midi.Sequence;
  34 
  35 /**
  36  * A {@code MidiFileWriter} supplies MIDI file-writing services. Classes that
  37  * implement this interface can write one or more types of MIDI file from a
  38  * {@link Sequence} object.
  39  *
  40  * @author Kara Kytle
  41  * @since 1.3
  42  */
  43 public abstract class MidiFileWriter {
  44 
  45     /**
  46      * Constructs a {@code MidiFileWriter}.
  47      */
  48     protected MidiFileWriter() {}
  49 
  50     /**
  51      * Obtains the set of MIDI file types for which file writing support is
  52      * provided by this file writer.
  53      *
  54      * @return array of file types. If no file types are supported, an array of
  55      *         length 0 is returned.
  56      */
  57     public abstract int[] getMidiFileTypes();
  58 
  59     /**
  60      * Obtains the file types that this file writer can write from the sequence
  61      * specified.
  62      *
  63      * @param  sequence the sequence for which MIDI file type support is queried
  64      * @return array of file types. If no file types are supported, returns an
  65      *         array of length 0.
  66      * @throws NullPointerException if {@code sequence} is {@code null}
  67      */
  68     public abstract int[] getMidiFileTypes(Sequence sequence);


< prev index next >