net.charlesames.music.musicxml.attribute
Enum Indication

java.lang.Object
  java.lang.Enum<Indication>
      net.charlesames.music.musicxml.attribute.Indication

All Implemented Interfaces:

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

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

Indications are MusicXML classes that tell how notes should be played.

Author:

Charles Ames

Enum Constant Summary

accent
MusicXML pass-through indication for accent.

breathMark
MusicXML pass-through indication for breath mark.

caesura
MusicXML pass-through indication for caesura.

detachedLegato
MusicXML pass-through indication for detached legato.

doit
MusicXML pass-through indication for doit.

downBow
MusicXML pass-through indication for down-bow.

falloff
MusicXML pass-through indication for falloff.

finger0
MusicXML pass-through indication for finger #0.

finger1
MusicXML pass-through indication for finger #1.

finger2
MusicXML pass-through indication for finger #2.

finger3
MusicXML pass-through indication for finger #3.

finger4
MusicXML pass-through indication for finger #4.

finger5
MusicXML pass-through indication for finger #5.

open
MusicXML pass-through indication for unstopped notes or natural harmonics.

plop
MusicXML pass-through indication for plop.

scoop
MusicXML pass-through indication for scoop.

spiccato
MusicXML pass-through indication for spiccato.

staccatissimo
MusicXML pass-through indication for staccatissimo.

staccato
MusicXML pass-through indication for staccato.

stopped
MusicXML pass-through indication for stopped.

strongAccent
MusicXML pass-through indication for strong accent.

tenuto
MusicXML pass-through indication for tenuto.

upBow
MusicXML pass-through indication for up-bow.

Method Summary

java.lang.String	getContent()
java.lang.Class<? extends Notation>	getNotationClass()
Notation	getNotationInstance(MusicXmlEntity container) Create a Music XMLNotation instance as a child of the indicated parent.
boolean	isPlacedAsVoice()
static Indication	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Indication[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
static java.util.SortedMap<java.lang.String,Indication>	valuesByName() Get the collection of indications.

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

upBow

public static final Indication upBow

MusicXML pass-through indication for up-bow.

downBow

public static final Indication downBow

MusicXML pass-through indication for down-bow.

open

public static final Indication open

MusicXML pass-through indication for unstopped notes or natural harmonics.

stopped

public static final Indication stopped

MusicXML pass-through indication for stopped.

finger0

public static final Indication finger0

MusicXML pass-through indication for finger #0.

finger1

public static final Indication finger1

MusicXML pass-through indication for finger #1.

finger2

public static final Indication finger2

MusicXML pass-through indication for finger #2.

finger3

public static final Indication finger3

MusicXML pass-through indication for finger #3.

finger4

public static final Indication finger4

MusicXML pass-through indication for finger #4.

finger5

public static final Indication finger5

MusicXML pass-through indication for finger #5.

accent

public static final Indication accent

MusicXML pass-through indication for accent.

strongAccent

public static final Indication strongAccent

MusicXML pass-through indication for strong accent.

detachedLegato

public static final Indication detachedLegato

MusicXML pass-through indication for detached legato.

spiccato

public static final Indication spiccato

MusicXML pass-through indication for spiccato.

staccatissimo

public static final Indication staccatissimo

MusicXML pass-through indication for staccatissimo.

tenuto

public static final Indication tenuto

MusicXML pass-through indication for tenuto.

staccato

public static final Indication staccato

MusicXML pass-through indication for staccato.

scoop

public static final Indication scoop

MusicXML pass-through indication for scoop.

plop

public static final Indication plop

MusicXML pass-through indication for plop.

doit

public static final Indication doit

MusicXML pass-through indication for doit.

falloff

public static final Indication falloff

MusicXML pass-through indication for falloff.

breathMark

public static final Indication breathMark

MusicXML pass-through indication for breath mark.

caesura

public static final Indication caesura

MusicXML pass-through indication for caesura.

Method Detail

values

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

Returns:

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

valueOf

public static Indication 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

valuesByName

public static java.util.SortedMap<java.lang.String,Indication> valuesByName()

Get the collection of indications.

Returns:

A collection of Indication instances, indexed by name.

getNotationInstance

public Notation getNotationInstance(MusicXmlEntity container)

Create a Music XMLNotation instance as a child of the indicated parent.

Parameters:

container - MusicXML Directions contain Notations associated with individual notes, while MusicXML Directives Notations associated with the staff.

Returns:

A newly created Notation instance.

getNotationClass

public java.lang.Class<? extends Notation> getNotationClass()

Returns:

The MusicXML class created to realize the Indication.

getContent

public java.lang.String getContent()

Returns:

The text content.

isPlacedAsVoice

public boolean isPlacedAsVoice()

Returns:

True if the indication placement should correspond to the voice placement.