jp.kshoji.javax.sound.midi.spi

Class MidiFileWriter

java.lang.Object

jp.kshoji.javax.sound.midi.spi.MidiFileWriter

Direct Known Subclasses:

StandardMidiFileWriter

public abstract class MidiFileWriter
extends Object

Abstract class for MIDI File Writer

Author:

K.Shoji

Constructor Summary

Constructors

Constructor and Description
MidiFileWriter()

Method Summary

Modifier and Type	Method and Description
abstract int[]	getMidiFileTypes() Get the all of the file types ID
abstract int[]	getMidiFileTypes(Sequence sequence) Get the all of the file types ID on the specified Sequence
boolean	isFileTypeSupported(int fileType) Check if the specified file type is supported
boolean	isFileTypeSupported(int fileType, Sequence sequence) Check if the specified file type is supported on the specified Sequence
abstract int	write(Sequence sequence, int fileType, File file) Write the Sequence to the File with the file type
abstract int	write(Sequence sequence, int fileType, OutputStream outputStream) Write the Sequence to the OutputStream with the file type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MidiFileWriter

public MidiFileWriter()

Method Detail

getMidiFileTypes

@NonNull
public abstract int[] getMidiFileTypes()

Get the all of the file types ID

Returns:

the array of file type

getMidiFileTypes

@NonNull
public abstract int[] getMidiFileTypes(@NonNull
                                                 Sequence sequence)

Get the all of the file types ID on the specified Sequence

Parameters:

sequence - the sequence

Returns:

the array of file type

isFileTypeSupported

public boolean isFileTypeSupported(int fileType)

Check if the specified file type is supported

Parameters:

fileType - the file type

Returns:

true if the specified file type is supported

isFileTypeSupported

public boolean isFileTypeSupported(int fileType,
                                   @NonNull
                                   Sequence sequence)

Check if the specified file type is supported on the specified Sequence

Parameters:

fileType - the file type

sequence - the sequence

Returns:

true if the specified file type is supported on the sequence

write

public abstract int write(@NonNull
                          Sequence sequence,
                          int fileType,
                          @NonNull
                          File file)
                   throws IOException

Write the Sequence to the File with the file type

Parameters:

sequence - the sequence

fileType - the file type

file - the file

Returns:

the written data length

Throws:

IOException

write

public abstract int write(@NonNull
                          Sequence sequence,
                          int fileType,
                          @NonNull
                          OutputStream outputStream)
                   throws IOException

Write the Sequence to the OutputStream with the file type

Parameters:

sequence - the sequence

fileType - the file type

outputStream - the OutputStream

Returns:

the written data length

Throws:

IOException