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
020
021/**
022 * Thrown by parameter groups
023 * ({@linkplain ParameterValueGroup value} and {@linkplain ParameterDescriptorGroup descriptor})
024 * when a parameter is requested but not found in that group.
025 * This exception is typically thrown by the following methods:
026 *
027 * <ul>
028 *   <li>{@link ParameterDescriptorGroup#descriptor(String)}</li>
029 *   <li>{@link ParameterValueGroup#parameter(String)}</li>
030 *   <li>{@link ParameterValueGroup#groups(String)}</li>
031 * </ul>
032 *
033 * @author  Martin Desruisseaux (IRD)
034 * @version 3.0
035 * @since   1.0
036 *
037 * @see InvalidParameterNameException
038 */
039public class ParameterNotFoundException extends IllegalArgumentException {
040    /**
041     * Serial number for inter-operability with different versions.
042     */
043    private static final long serialVersionUID = -8074834945993975175L;
044
045    /**
046     * The invalid parameter name.
047     */
048    private final String parameterName;
049
050    /**
051     * Creates an exception with the specified message and parameter name.
052     *
053     * @param message        the detail message, saved for later retrieval by the {@link #getMessage()} method.
054     * @param parameterName  the name of the parameter which was required but not found.
055     */
056    public ParameterNotFoundException(String message, String parameterName) {
057        super(message);
058        this.parameterName = parameterName;
059    }
060
061    /**
062     * Returns the name of the parameter which was required but not found.
063     *
064     * @return the required parameter name.
065     */
066    public String getParameterName() {
067        return parameterName;
068    }
069}