001/*
002 *    GeoAPI - Java interfaces for OGC/ISO standards
003 *    Copyright © 2004-2023 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.coordinate;
019
020import org.opengis.geometry.DirectPosition;
021
022
023/**
024 * Indicates that an operation cannot be completed properly because of a
025 * mismatch in the number of dimensions of an argument given to a method.
026 * For example, this exception may be thrown if a method expects a two-dimensional {@link DirectPosition}
027 * argument but the {@linkplain DirectPosition#getDimension() dimension} of a given position was 3.
028 *
029 * @author  Martin Desruisseaux (IRD, Geomatys)
030 * @version 3.1
031 * @since   3.1
032 */
033public class MismatchedDimensionException extends MismatchedCoordinateMetadataException {
034    /**
035     * Serial number for inter-operability with different versions.
036     */
037    private static final long serialVersionUID = 3138484331425225155L;
038
039    /**
040     * Creates an exception with no message.
041     */
042    public MismatchedDimensionException() {
043    }
044
045    /**
046     * Creates an exception with the specified message.
047     *
048     * @param message  the detail message, saved for later retrieval by the {@link #getMessage()} method.
049     */
050    public MismatchedDimensionException(String message) {
051        super(message);
052    }
053
054    /**
055     * Creates an exception with the specified message and cause.
056     *
057     * @param message  the detail message, saved for later retrieval by the {@link #getMessage()} method.
058     * @param cause    the cause, saved for later retrieval by the {@link #getCause()} method.
059     */
060    public MismatchedDimensionException(String message, Throwable cause) {
061        super(message, cause);
062    }
063}