/**
 * Copyright (C) 2018 Adrien Hopkins
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
package unitConverter.unit;

/**
 * The SI prefixes.
 * 
 * @author Adrien Hopkins
 * @since 2019-01-14
 * @since v0.1.0
 */
public enum SIPrefix implements UnitPrefix {
	DECA(10), HECTO(100), KILO(1e3), MEGA(1e6), GIGA(1e9), TERA(1e12), PETA(1e15), EXA(1e18), ZETTA(1e21), YOTTA(
			1e24), DECI(0.1), CENTI(0.01), MILLI(
					1e-3), MICRO(1e-6), NANO(1e-9), PICO(1e-12), FEMTO(1e-15), ATTO(1e-18), ZEPTO(1e-21), YOCTO(1e-24);

	private final double multiplier;

	/**
	 * Creates the {@code SIPrefix}.
	 * 
	 * @param multiplier
	 *            prefix's multiplier
	 * @since 2019-01-14
	 * @since v0.1.0
	 */
	private SIPrefix(final double multiplier) {
		this.multiplier = multiplier;
	}

	/**
	 * @return value
	 * @since 2019-01-14
	 * @since v0.1.0
	 */
	@Override
	public final double getMultiplier() {
		return this.multiplier;
	}
}