net.kreatious.pianoleopard.midi

Enum OutputModel.EventAction

java.lang.Object

java.lang.Enum<OutputModel.EventAction>

net.kreatious.pianoleopard.midi.OutputModel.EventAction

All Implemented Interfaces:

Serializable, Comparable<OutputModel.EventAction>

Enclosing class:

OutputModel

public static enum OutputModel.EventAction
extends Enum<OutputModel.EventAction>

Indicates which action to take in response to an event handler.

The action with the highest priority takes precedence.

Author:

Jay-R Studer

Enum Constant Summary

Enum Constants

Enum Constant and Description
MUTE Returned if the event should be muted.
PLAY Return if the event should be played.
UNHANDLED Returned if it doesn't matter if the event is muted.

Method Summary

Modifier and Type	Method and Description
static OutputModel.EventAction	valueOf(String name) Returns the enum constant of this type with the specified name.
static OutputModel.EventAction[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PLAY

public static final OutputModel.EventAction PLAY

Return if the event should be played. Has the highest priority.

MUTE

public static final OutputModel.EventAction MUTE

Returned if the event should be muted. Has medium priority.

UNHANDLED

public static final OutputModel.EventAction UNHANDLED

Returned if it doesn't matter if the event is muted. Has the lowest priority.

An event that is not handled by all handlers will be played.

Event handlers are allowed to change the MidiMessage before it is sent.

Method Detail

values

public static OutputModel.EventAction[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (OutputModel.EventAction c : OutputModel.EventAction.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static OutputModel.EventAction valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null