net.charlesames.music.ensemble
Enum NoteListFormat

java.lang.Object
  java.lang.Enum<NoteListFormat>
      net.charlesames.music.ensemble.NoteListFormat

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<NoteListFormat>

public enum NoteListFormat
extends java.lang.Enum<NoteListFormat>

Output formats for MUSIC-N Note lists.

Author:

Charles Ames

Enum Constant Summary

MUSICV
MUSIC-V output format, as described in The Technology of Computer Music.

NONE
No defined output format.

SOUND
Output format for Charles Ames's SOUND program.

Method Summary

abstract void	configureEnsemble(Ensemble ensemble) Configure the indicated ensemble to employ this format;
NoteAttribute	getNoteAttribute(int parameterID) Get the NoteAttribute associated with the indicated parameter ID.
java.util.SortedMap<java.lang.Integer,NoteAttribute>	getNoteAttributes() Get the sequence of NoteAttribute mappings.
static NoteListFormat	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static NoteListFormat[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final NoteListFormat NONE

No defined output format.

MUSICV

public static final NoteListFormat MUSICV

MUSIC-V output format, as described in The Technology of Computer Music.

SOUND

public static final NoteListFormat SOUND

Output format for Charles Ames's SOUND program.

Method Detail

values

public static NoteListFormat[] 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 (NoteListFormat c : NoteListFormat.values())
    System.out.println(c);

Returns:

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

valueOf

public static NoteListFormat valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

configureEnsemble

public abstract void configureEnsemble(Ensemble ensemble)

Configure the indicated ensemble to employ this format;

Parameters:

ensemble - The indicated ensemble.

getNoteAttribute

public NoteAttribute getNoteAttribute(int parameterID)

Get the NoteAttribute associated with the indicated parameter ID.

Parameters:

parameterID - The indicated parameter ID.

Returns:

The NoteAttribute associated with the indicated parameter ID.

getNoteAttributes

public java.util.SortedMap<java.lang.Integer,NoteAttribute> getNoteAttributes()

Get the sequence of NoteAttribute mappings.

Returns:

A mapping from integer parameter ids to NoteAttribute instances.