org.midica.file.write

Class ExportException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.midica.file.write.ExportException

All Implemented Interfaces:

java.io.Serializable

public class ExportException
extends java.lang.Exception

This class is used for exceptions that can occur during a file export process.

Author:

Jan Trukenmüller

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private int	channel
private boolean	composed false: simple string messge; true: complex message containing string, tick, channel, note
private java.lang.String	msg
private int	note
private static long	serialVersionUID
private java.lang.Long	tick

Constructor Summary

Constructors

Constructor and Description
ExportException(java.lang.Long tick, int channel, int note, java.lang.String msg) Creator of a composed error message containing details like tickstamp, channel, note number etc.
ExportException(java.lang.String msg) Creator of a simple export exception, containing only a simple string.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getErrorMessage() Returns the final error message.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

composed

private boolean composed

false: simple string messge; true: complex message containing string, tick, channel, note

tick

private java.lang.Long tick

channel

private int channel

note

private int note

msg

private java.lang.String msg

Constructor Detail

ExportException

public ExportException(java.lang.String msg)

Creator of a simple export exception, containing only a simple string. This is used for IO errors regarding the export file or MIDI exports.

Parameters:

msg - Error message

ExportException

public ExportException(java.lang.Long tick,
                       int channel,
                       int note,
                       java.lang.String msg)

Creator of a composed error message containing details like tickstamp, channel, note number etc. This is used in the MidicaPLExporter class when an event has occured that cannot be handled properly.

Parameters:

tick - Tickstamp of the event that caused the exception.

channel - Channel where the event occured – or -1 if it wasn’t a channel based event.

note - Note number of the event – or -1 if no note was involved.

msg - Error message

Method Detail

getErrorMessage

public java.lang.String getErrorMessage()

Returns the final error message. In case of a simple message the error message provided to the constructor is left unchanged. In the case of a composed message it contains more details.

Returns:

Error message