io.jenetics.jpx.Degrees Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jpx Show documentation
JPX - Java GPX (GPS) Library
There is a newer version: 3.2.0
/*
 * Java GPX Library (jpx-2.0.0).
 * Copyright (c) 2016-2020 Franz Wilhelmstötter
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * Author:
 *    Franz Wilhelmstötter ([email protected])
 */
package io.jenetics.jpx;

import static java.lang.String.format;

import java.io.DataInput;
import java.io.DataOutput;
import java.io.IOException;
import java.io.InvalidObjectException;
import java.io.ObjectInputStream;
import java.io.Serializable;

/**
 * Used for bearing, heading, course. Base unit is decimal degree. Only values
 * in the range of {@code [0..360]} are valid.
 *
 * @see Value object
 *
 * @author Franz Wilhelmstötter
 * @version 2.0
 * @since 1.0
 */
public final class Degrees
	extends Number
	implements
		Comparable,
		Serializable
{

	private static final long serialVersionUID = 2L;

	/**
	 * A constant holding the maximum value a {@code Degrees} value can have,
	 * 0 inclusively.
	 *
	 * @since 2.0
	 */
	public static final double MIN_VALUE = 0;

	/**
	 * A constant holding the maximum value a {@code Degrees} value can have,
	 * 360 inclusively.
	 *
	 * @since 2.0
	 */
	public static final double MAX_VALUE = 360;

	private final double _value;

	/**
	 * Create a new {@code Degrees} object with the given decimal degree
	 * value.
	 *
	 * @param value the decimal degree value
	 * @throws IllegalArgumentException if the give value is not within the
	 *         range of {@code [0..360]}
	 */
	private Degrees(final double value) {
		if (value < MIN_VALUE || value >= MAX_VALUE) {
			throw new IllegalArgumentException(format(
				"%f not in the range [0, 360).", value
			));
		}

		_value = value;
	}

	/**
	 * Return the decimal degree value.
	 *
	 * @return the decimal degree value
	 */
	@Override
	public double doubleValue() {
		return _value;
	}

	/**
	 * Return the degrees in radians.
	 *
	 * @return the degrees in radians
	 */
	public double toRadians() {
		return Math.toRadians(_value);
	}

	/**
	 * Return the decimal degree value.
	 *
	 * @return the decimal degree value
	 */
	public double toDegrees() {
		return _value;
	}

	@Override
	public int intValue() {
		return (int)doubleValue();
	}

	@Override
	public long longValue() {
		return (long)doubleValue();
	}

	@Override
	public float floatValue() {
		return (float)doubleValue();
	}

	@Override
	public int compareTo(final Degrees other) {
		return Double.compare(_value, other._value);
	}

	@Override
	public int hashCode() {
		return Double.hashCode(_value);
	}

	@Override
	public boolean equals(final Object obj) {
		return obj == this ||
			obj instanceof Degrees &&
			Double.compare(((Degrees)obj)._value, _value) == 0;
	}

	@Override
	public String toString() {
		return Double.toString(_value);
	}


	/* *************************************************************************
	 *  Static object creation methods
	 * ************************************************************************/

	/**
	 * Create a new {@code Degrees} object with the given decimal degree
	 * value.
	 *
	 * @param degrees the decimal degree value
	 * @return a new {@code Degrees} object
	 * @throws IllegalArgumentException if the give value is not within the
	 *         range of {@code [0..360]}
	 */
	public static Degrees ofDegrees(final double degrees) {
		return new Degrees(degrees);
	}

	/**
	 * Create a new {@code Degrees} object with the given radians value.
	 *
	 * @param radians the radians value
	 * @return a new {@code Degrees} object
	 * @throws IllegalArgumentException if the give value is not within the
	 *         range of {@code [0..2*Pi]}
	 */
	public static Degrees ofRadians(final double radians) {
		return new Degrees(Math.toDegrees(radians));
	}

	static Degrees parse(final String value) {
		final String deg = Strings.trim(value);

		return deg != null
			? Degrees.ofDegrees(Double.parseDouble(deg))
			: null;
	}

	/* *************************************************************************
	 *  Java object serialization
	 * ************************************************************************/

	private Object writeReplace() {
		return new Serial(Serial.DEGREES, this);
	}

	private void readObject(final ObjectInputStream stream)
		throws InvalidObjectException
	{
		throw new InvalidObjectException("Serialization proxy required.");
	}

	void write(final DataOutput out) throws IOException {
		out.writeDouble(_value);
	}

	static Degrees read(final DataInput in) throws IOException {
		return new Degrees(in.readDouble());
	}

}