org.decimal4j.truncate.OverflowMode Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of decimal4j Show documentation

Java library for fast fixed precision arithmetics based on longs with support for up to 18 decimal places.

The newest version!

/**
 * The MIT License (MIT)
 *
 * Copyright (c) 2015-2016 decimal4j (tools4j), Marco Terzer
 *
 * 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.decimal4j.truncate;

/**
 * Mode to apply if arithmetic operations cause an overflow.
 */
public enum OverflowMode {
	/**
	 * Operations causing an overflow silently return the truncated result (the
	 * low order bytes of the extended result); no exception is thrown.
	 */
	UNCHECKED, //
	/**
	 * Operations causing an overflow throw an {@link ArithmeticException}.
	 */
	CHECKED;

	/**
	 * Returns true if overflow leads to an {@link ArithmeticException}
	 * 
	 * @return true if {@code this == CHECKED}
	 */
	public final boolean isChecked() {
		return this == CHECKED;
	}
}