src.main.java.org.point85.uom.Prefix Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of caliper Show documentation
Units of Measure
The newest version!
/*
MIT License

Copyright (c) 2016 Kent Randall

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.
*/

package org.point85.uom;

import java.util.ArrayList;
import java.util.List;

/**
 * The Prefix class defines SI unit of measure prefixes as well as those found
 * in computer science.
 */
public class Prefix {
	// list of pre-defined prefixes
	private static List prefixes = new ArrayList<>();

	// SI prefix 10^24
	public static final Prefix YOTTA = new Prefix("yotta", "Y", 1.0E+24);
	// SI prefix 10^21
	public static final Prefix ZETTA = new Prefix("zetta", "Z", 1.0E+21);
	// SI prefix 10^18
	public static final Prefix EXA = new Prefix("exa", "E", 1.0E+18);
	// SI prefix 10^15
	public static final Prefix PETA = new Prefix("petta", "P", 1.0E+15);
	// SI prefix 10^12
	public static final Prefix TERA = new Prefix("tera", "T", 1.0E+12);
	// SI prefix 10^9
	public static final Prefix GIGA = new Prefix("giga", "G", 1.0E+09);
	// SI prefix 10^6
	public static final Prefix MEGA = new Prefix("mega", "M", 1.0E+06);
	// SI prefix 10^3
	public static final Prefix KILO = new Prefix("kilo", "k", 1.0E+03);
	// SI prefix 10^2
	public static final Prefix HECTO = new Prefix("hecto", "h", 1.0E+02);
	// SI prefix 10
	public static final Prefix DEKA = new Prefix("deka", "da", 1.0E+01);
	// SI prefix 10^-1
	public static final Prefix DECI = new Prefix("deci", "d", 1.0E-01);
	// SI prefix 10^-2
	public static final Prefix CENTI = new Prefix("centi", "c", 1.0E-02);
	// SI prefix 10^-3
	public static final Prefix MILLI = new Prefix("milli", "m", 1.0E-03);
	// SI prefix 10^-6
	public static final Prefix MICRO = new Prefix("micro", "\u03BC", 1.0E-06);
	// SI prefix 10^-9
	public static final Prefix NANO = new Prefix("nano", "n", 1.0E-09);
	// SI prefix 10^-12
	public static final Prefix PICO = new Prefix("pico", "p", 1.0E-12);
	// SI prefix 10^-15
	public static final Prefix FEMTO = new Prefix("femto", "f", 1.0E-15);
	// SI prefix 10^-18
	public static final Prefix ATTO = new Prefix("atto", "a", 1.0E-18);
	// SI prefix 10^-21
	public static final Prefix ZEPTO = new Prefix("zepto", "z", 1.0E-21);
	// SI prefix 10^-24
	public static final Prefix YOCTO = new Prefix("yocto", "y", 1.0E-24);

	// Digital information prefixes for bytes established by the International
	// Electrotechnical Commission (IEC) in 1998
	public static final Prefix KIBI = new Prefix("kibi", "Ki", 1024);
	//
	public static final Prefix MEBI = new Prefix("mebi", "Mi", 1.048576E+06);
	//
	public static final Prefix GIBI = new Prefix("gibi", "Gi", 1.073741824E+09);

	// name
	private String name;

	// symbol
	private String symbol;

	// factor
	private double factor;

	/**
	 * Construct a prefix
	 * 
	 * @param name
	 *            Name
	 * @param symbol
	 *            Symbol
	 * @param factor
	 *            Numerical factor
	 */
	public Prefix(String name, String symbol, double factor) {
		this.name = name;
		this.symbol = symbol;
		this.factor = factor;

		prefixes.add(this);
	}

	/**
	 * Get the name of the prefix
	 * 
	 * @return prefix name
	 */
	public String getName() {
		return this.name;
	}

	/**
	 * Get the symbol for the prefix
	 * 
	 * @return symbol
	 */
	public String getSymbol() {
		return this.symbol;
	}

	/**
	 * Get the scaling factor
	 * 
	 * @return Scaling factor
	 */
	public double getFactor() {
		return factor;
	}

	/**
	 * Find the prefix with the specified name
	 * 
	 * @param name
	 *            Name of prefix
	 * @return {@link Prefix}
	 */
	public static Prefix fromName(String name) {
		Prefix prefix = null;

		for (Prefix p : prefixes) {
			if (p.getName().equals(name)) {
				prefix = p;
				break;
			}
		}

		return prefix;
	}

	/**
	 * Find the prefix with the specified scaling factor
	 * 
	 * @param factor
	 *            Scaling factor
	 * @return {@link Prefix}
	 */
	public static Prefix fromFactor(double factor) {
		Prefix prefix = null;

		for (Prefix p : prefixes) {
			if (p.getFactor() == factor) {
				prefix = p;
				break;
			}
		}

		return prefix;
	}

	/**
	 * Get the list of pre-defined prefixes
	 * 
	 * @return Prefix list
	 */
	public static List getDefinedPrefixes() {
		return prefixes;
	}

	/**
	 * Create a String representation of this Prefix
	 */
	@Override
	public String toString() {
		return name + ", " + symbol + ", " + factor;
	}
}