io.jenetics.jpx.Fix 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.1
/*
 * Java GPX Library (jpx-3.0.0).
 * Copyright (c) 2016-2022 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.util.Objects.requireNonNull;

import java.util.Optional;

/**
 * Type of GPS fix. {@code none} means GPS had no fix. To signify "the fix info
 * is unknown, leave out {@code Fix} entirely. {@code pps} = military signal
 * used.
 *
 * @author Franz Wilhelmstötter
 * @version 1.2
 * @since 1.0
 */
public enum  Fix {

	NONE("none"),
	DIM_2("2d"),
	DIM_3("3d"),
	DGPS("dgps"),
	PPS("pps");

	private final String _value;

	Fix(final String value) {
		_value = requireNonNull(value);
	}

	/**
	 * Return the string representation of the GPS {@code Fix}. {@code none},
	 * {@code 2d}. {@code 3d}, {@code dgps} or {@code pps}.
	 *
	 * @return the string representation of the GPS {@code Fix}
	 */
	public String getValue() {
		return _value;
	}

	/**
	 * Return the {@code Fix} constant for the given fix {@code value}.
	 *
	 * @param name the GPS fix names
	 * @return the GPS fix for the given value, or {@code Optional.empty()} if
	 *         the given {@code name} is invalid
	 */
	public static Optional ofName(final String name) {
		return switch (name) {
			case "none" -> Optional.of(Fix.NONE);
			case "2d" -> Optional.of(Fix.DIM_2);
			case "3d" -> Optional.of(Fix.DIM_3);
			case "dgps" -> Optional.of(Fix.DGPS);
			case "pps" -> Optional.of(Fix.PPS);
			default -> Optional.empty();
		};
	}

	static String format(final Fix fix) {
		return fix != null ? fix._value : null;
	}

	static Fix parse(final String value) {
		final String fix = Strings.trim(value);

		return fix != null
			? Fix.ofName(fix).orElseThrow(() ->
				new IllegalArgumentException(String.format(
					"Invalid value for: '%s'.", fix)))
			: null;
	}
}