Package org.bukkit
Enum Class Note.Tone
- All Implemented Interfaces:
Serializable
,Comparable<Note.Tone>
,Constable
- Enclosing class:
Note
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
-
Field Summary
Modifier and TypeFieldDescriptionstatic final byte
The number of tones including sharped tones. -
Method Summary
Modifier and TypeMethodDescriptiongetById
(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
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
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.
-
Enum Constant Details
-
G
-
A
-
B
-
C
-
D
-
E
-
F
-
-
Field Details
-
TONES_COUNT
public static final byte TONES_COUNTThe number of tones including sharped tones.- See Also:
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
getId
Returns the not sharped id of this tone.- Returns:
- the not sharped id of this tone.
- API Note:
- Internal Use Only
-
getId
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
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
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
-