/*
 * MIT License
 *
 * Copyright (c) 2016 Gahwon "creativitRy" Lee and Henry "theKidOfArcrania" Wang
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

/**
 * Keys (all in major)
 *
 * @author creativitRy
 * Date: 10/29/2016.
 */
package com.ctry.clearcomposer.music;

public enum Key
{
	C(3),
	G(10),
	D(5),
	A(0),
	E(7),
	B(2),
	Fs(9),
	Cs(4),
	F(8),
	Bb(1),
	Eb(6),
	Ab(11),
	Db(4),
	Gb(9),
	Cb(2);

	private int pitch;

	Key(int num)
	{
		pitch = num;
	}

	/**
	 * absolute note of the root of the key
	 * @return root
	 */
	public AbsoluteNote getNote()
	{
		return AbsoluteNote.values()[pitch];
	}

	/**
	 * nicely formatted key root
	 * @return
	 */
	public String toString()
	{
		return String.format("%2s Major", name().replace('s', '#'));
	}

}
