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.parameter;
019
020import org.opengis.annotation.UML;
021import static org.opengis.annotation.Specification.*;
022
023
024/**
025 * Thrown when an unexpected parameter was found in a {@linkplain ParameterDescriptorGroup parameter group}.
026 * For example, this exception may be thrown at construction time if the same parameter name is used twice.
027 *
028 * @author  Martin Desruisseaux (IRD)
029 * @version 3.0
030 * @since   1.0
031 *
032 * @see ParameterNotFoundException
033 */
034@UML(identifier="GC_InvalidParameterName", specification=OGC_01004)
035public class InvalidParameterNameException extends IllegalArgumentException {
036    /**
037     * Serial number for inter-operability with different versions.
038     */
039    private static final long serialVersionUID = -8473266898408204803L;
040
041    /**
042     * The invalid parameter name.
043     */
044    private final String parameterName;
045
046    /**
047     * Creates an exception with the specified message and parameter name.
048     *
049     * @param message        the detail message, saved for later retrieval by the {@link #getMessage()} method.
050     * @param parameterName  the invalid parameter name.
051     */
052    public InvalidParameterNameException(String message, String parameterName) {
053        super(message);
054        this.parameterName = parameterName;
055    }
056
057    /**
058     * Creates an exception with the specified message, cause and parameter name.
059     *
060     * @param message        the detail message, saved for later retrieval by the {@link #getMessage()} method.
061     * @param cause          the cause, saved for later retrieval by the {@link #getCause()} method.
062     * @param parameterName  the invalid parameter name.
063     *
064     * @since 3.1
065     */
066    public InvalidParameterNameException(String message, Throwable cause, String parameterName) {
067        super(message, cause);
068        this.parameterName = parameterName;
069    }
070
071    /**
072     * Returns the invalid parameter name.
073     *
074     * @return the name of the invalid parameter.
075     */
076    public String getParameterName() {
077        return parameterName;
078    }
079}