net.charlesames.music.musicxml.attribute
Enum BeamValue

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

All Implemented Interfaces:

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

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

Selection options for MusicXML BeamValue attributes.

Author:

Charles Ames

Enum Constant Summary

BACKWARD_HOOK
Backward hook

BEGIN
Initial stem in beam

CONTINUE
Intervening stem in beam

END
Final stem in beam

FORWARD_HOOK
Forward hook

Method Summary

static BeamValue	fromText(java.lang.String text) Convert beam value text to BeamValue instance.
java.lang.String	text() The text value associated with this enumeration element.
static BeamValue	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static BeamValue[]	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

BEGIN

public static final BeamValue BEGIN

Initial stem in beam

CONTINUE

public static final BeamValue CONTINUE

Intervening stem in beam

END

public static final BeamValue END

Final stem in beam

FORWARD_HOOK

public static final BeamValue FORWARD_HOOK

Forward hook

BACKWARD_HOOK

public static final BeamValue BACKWARD_HOOK

Backward hook

Method Detail

values

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

Returns:

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

valueOf

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

text

public java.lang.String text()

The text value associated with this enumeration element.

Returns:

The text value associated with this enumeration element.

fromText

public static BeamValue fromText(java.lang.String text)

Convert beam value text to BeamValue instance.

Parameters:

text - Text content from an XML element.

Returns:

The BeamValue corresponding to the indicated text.

Throws:

java.lang.IllegalArgumentException - when there is no corresponding BeamValue instance.