tec.units.ri.spi.BinaryPrefix Maven / Gradle / Ivy

Go to download
/**
 *  Unit-API - Units of Measurement API for Java
 *  Copyright (c) 2005-2014, Jean-Marie Dautelle, Werner Keil, V2COM.
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
 *
 * 3. Neither the name of JSR-363 nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package tec.units.ri.spi;

import javax.measure.Quantity;
import javax.measure.Unit;

/**
 *  This class provides support for common binary prefixes to be used by
 *     units.
 *
 * @author Werner Keil
 * @version 0.5.2, December 24, 2013
 */
public final class BinaryPrefix {
	
     /**
     * Default constructor (private).
     */
	private BinaryPrefix() {
		// Utility class no visible constructor.
	}

	/**
	 * Returns the specified unit multiplied by the factor
	 * 2¹⁰ (binary prefix).
	 * 
	 * @param unit any unit.
	 * @return unit.times(1024).
	 */
	public static > Unit KIBI(Unit unit) {
		return unit.multiply(1024);
	}

	/**
	 * Returns the specified unit multiplied by the factor
	 * 2²⁰ (binary prefix).
	 * 
	 * @param unit any unit.
	 * @return unit.times(1048576).
	 */
	public static > Unit MEBI(Unit unit) {
		return unit.multiply(1048576);
	}

	/**
	 * Returns the specified unit multiplied by the factor
	 * 2³⁰ (binary prefix).
	 * 
	 * @param unit any unit.
	 * @return unit.times(1073741824).
	 */
	public static > Unit GIBI(Unit unit) {
		return unit.multiply(1073741824);
	}

	/**
	 * Returns the specified unit multiplied by the factor
	 * 2⁴⁰ (binary prefix).
	 * 
	 * @param unit any unit.
	 * @return unit.times(1099511627776L).
	 */
	public static > Unit TEBI(Unit unit) {
		return unit.multiply(1099511627776L);
	}

	/**
	 * Returns the specified unit multiplied by the factor
	 * 2⁵⁰ (binary prefix).
	 * 
	 * @param unit any unit.
	 * @return unit.times(1125899906842624L).
	 */
	public static > Unit PEBI(Unit unit) {
		return unit.multiply(1125899906842624L);
	}

	/**
	 * Returns the specified unit multiplied by the factor
	 * 2⁶⁰ (binary prefix).
	 * 
	 * @param unit any unit.
	 * @return unit.times(1152921504606846976L).
	 */
	public static > Unit EXBI(Unit unit) {
		return unit.multiply(1152921504606846976L);
	}
}