Package org.bukkit

Enum Class Note.Tone

java.lang.Object

java.lang.Enum<Note.Tone>

org.bukkit.Note.Tone

All Implemented Interfaces:

Serializable, Comparable<Note.Tone>, Constable

Enclosing class:

Note

public static enum Note.Tone
extends Enum<Note.Tone>

An enum holding tones.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
A
B
C
D
E
F
G

Field Summary

Fields

Modifier and Type	Field	Description
static final byte	TONES_COUNT	The number of tones including sharped tones.

Method Summary

Modifier and Type	Method	Description
static @Nullable Note.Tone	getById(byte id)	Returns the tone to id.
byte	getId()	Returns the not sharped id of this tone.
byte	getId(boolean sharped)	Returns the id of this tone.
boolean	isSharpable()	Returns if this tone could be sharped.
boolean	isSharped(byte id)	Returns if this tone id is the sharped id of the tone.
static Note.Tone	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Note.Tone[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

G

public static final Note.Tone G

A

public static final Note.Tone A

B

public static final Note.Tone B

C

public static final Note.Tone C

D

public static final Note.Tone D

E

public static final Note.Tone E

F

public static final Note.Tone F

Field Details

TONES_COUNT

public static final byte TONES_COUNT

The number of tones including sharped tones.

See Also:

• Constant Field Values

Method Details

values

public static Note.Tone[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Note.Tone valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getId

@Internal
public byte getId()

Returns the not sharped id of this tone.

Returns:

the not sharped id of this tone.

API Note:

Internal Use Only

getId

@Internal
public byte getId(boolean sharped)

Returns the id of this tone. These method allows to return the sharped id of the tone. If the tone couldn't be sharped it always return the not sharped id of this tone.

Parameters:

sharped - Set to true to return the sharped id.

Returns:

the id of this tone.

API Note:

Internal Use Only

isSharpable

public boolean isSharpable()

Returns if this tone could be sharped.

Returns:

if this tone could be sharped.

isSharped

@Internal
public boolean isSharped(byte id)

Returns if this tone id is the sharped id of the tone.

Parameters:

id - the id of the tone.

Returns:

if the tone id is the sharped id of the tone.

Throws:

IllegalArgumentException - if neither the tone nor the semitone have the id.

API Note:

Internal Use Only

getById

@Internal
@Nullable
public static @Nullable Note.Tone getById(byte id)

Returns the tone to id. Also returning the semitones.

Parameters:

id - the id of the tone.

Returns:

the tone to id.

API Note:

Internal Use Only