001/*
002 *    GeoAPI - Java interfaces for OGC/ISO standards
003 *    Copyright © 2006-2024 Open Geospatial Consortium, Inc.
004 *    http://www.geoapi.org
005 *
006 *    Licensed under the Apache License, Version 2.0 (the "License");
007 *    you may not use this file except in compliance with the License.
008 *    You may obtain a copy of the License at
009 *
010 *        http://www.apache.org/licenses/LICENSE-2.0
011 *
012 *    Unless required by applicable law or agreed to in writing, software
013 *    distributed under the License is distributed on an "AS IS" BASIS,
014 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 *    See the License for the specific language governing permissions and
016 *    limitations under the License.
017 */
018package org.opengis.temporal;
019
020import java.time.DateTimeException;
021
022
023/**
024 * Thrown when a temporal operation cannot be performed because a position has an indeterminate value.
025 *
026 * <h2>Example</h2>
027 * This exception should be thrown by {@link Instant#distance(TemporalPrimitive)} if
028 * {@link Instant#getIndeterminatePosition()} returns a non-empty value different than
029 * {@link IndeterminateValue#NOW}.
030 *
031 * @author  Martin Desruisseaux (Geomatys)
032 * @since   3.1
033 * @version 3.1
034 */
035public class IndeterminatePositionException extends DateTimeException {
036    /**
037     * Serial number for inter-operability with different versions.
038     */
039    private static final long serialVersionUID = -7483311297081181904L;
040
041    /**
042     * Constructs an exception with the specified detail message.
043     *
044     * @param message  the detail message, saved for later retrieval by the {@link #getMessage()} method.
045     */
046    public IndeterminatePositionException(String message) {
047        super(message);
048    }
049
050    /**
051     * Constructs an exception with the specified detail message and cause.
052     *
053     * @param message  the detail message, saved for later retrieval by the {@link #getMessage()} method.
054     * @param cause    the cause, saved for later retrieval by the {@link #getCause()} method.
055     */
056    public IndeterminatePositionException(String message, Throwable cause) {
057        super(message, cause);
058    }
059}