Enum Tone

src/main/java/org/bukkit/Note.java:14–122

An enum holding tones.

     * An enum holding tones.
     */
    public enum Tone {
        F((byte) -0x1, true),
        G((byte) 0x1, true),
        A((byte) 0x3, true),
        B((byte) 0x5, false),
        C((byte) 0x6, true),
        D((byte) 0x8, true),
        E((byte) 0xA, false);

        private final boolean sharpable;
        private final byte id;
        private static final Map<Byte, Note.Tone> tones = new HashMap<Byte, Note.Tone>();
        /** The number of tones including sharped tones. */
        public static final byte TONES_COUNT;

        private Tone(byte id, boolean sharpable) {
            this.id = id;
            this.sharpable = sharpable;
        }

        /**
         * Returns the not sharped id of this tone.
         *
         * @return the not sharped id of this tone.
         */
        public byte getId() {
            return getId(false);
        }

        /**
         * 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.
         *
         * @param sharped
         *            Set to true to return the sharped id.
         * @return the id of this tone.
         */
        public byte getId(boolean sharped) {
            byte tempId = (byte) (sharped && sharpable ? id + 1 : id);

            while (tempId < 0) {
                tempId += TONES_COUNT;
            }
            return (byte) (tempId % TONES_COUNT);
        }

        /**
         * Returns if this tone could be sharped.
         *
         * @return if this tone could be sharped.
         */
        public boolean isSharpable() {
            return sharpable;
        }

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