org.midica.file.write

Class Exporter

java.lang.Object

org.midica.file.write.Exporter

Direct Known Subclasses:

AudioExporter, Decompiler, MidiExporter

public abstract class Exporter
extends java.lang.Object

This class can be extended by exporter classes which write a music file based on a MIDI sequence.

Directly derived classes are:

• MidiExporter
• Decompiler
• AudioExporter

Author:

Jan Trukenmüller

Constructor Summary

Constructors

Constructor and Description
Exporter()

Method Summary

Modifier and Type	Method and Description
protected boolean	createFile(java.io.File file) Checks and creates the file.
abstract ExportResult	export(java.io.File file) Exports a file.

Methods inherited from class java.lang.Object

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

Constructor Detail

Exporter

public Exporter()

Method Detail

createFile

protected boolean createFile(java.io.File file)
                      throws ExportException

Checks and creates the file. Checks if the specified file can be created/written or already exists. If it already exists, asks for overwriting or not. If everything is correct, creates the file.

Parameters:

file - the file to be written

Returns:

true, if the file can be written. Otherwise: false.

Throws:

ExportException - if the file is not writable.

export

public abstract ExportResult export(java.io.File file)
                             throws ExportException

Exports a file.

Parameters:

file - Export file based on the loaded midi stream.

Returns:

Warnings that occured during the export.

Throws:

ExportException - If the file can not be exported correctly.