001    /*
002     *    GeoAPI - Java interfaces for OGC/ISO standards
003     *    http://www.geoapi.org
004     *
005     *    Copyright (C) 2004-2012 Open Geospatial Consortium, Inc.
006     *    All Rights Reserved. http://www.opengeospatial.org/ogc/legal
007     *
008     *    Permission to use, copy, and modify this software and its documentation, with
009     *    or without modification, for any purpose and without fee or royalty is hereby
010     *    granted, provided that you include the following on ALL copies of the software
011     *    and documentation or portions thereof, including modifications, that you make:
012     *
013     *    1. The full text of this NOTICE in a location viewable to users of the
014     *       redistributed or derivative work.
015     *    2. Notice of any changes or modifications to the OGC files, including the
016     *       date changes were made.
017     *
018     *    THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE
019     *    NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
020     *    TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT
021     *    THE USE OF THE SOFTWARE OR DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY
022     *    PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
023     *
024     *    COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR
025     *    CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENTATION.
026     *
027     *    The name and trademarks of copyright holders may NOT be used in advertising or
028     *    publicity pertaining to the software without specific, written prior permission.
029     *    Title to copyright in this software and any associated documentation will at all
030     *    times remain with copyright holders.
031     */
032    package org.opengis.parameter;
033    
034    
035    /**
036     * Thrown by {@link ParameterValueGroup} and {@link ParameterDescriptorGroup}
037     * when a parameter is requested but not found in that group.
038     *
039     * @departure extension
040     *   This exception is not part of OGC specification.
041     *
042     * @author  Martin Desruisseaux (IRD)
043     * @version 3.0
044     * @since   1.0
045     *
046     * @see ParameterValueGroup#parameter(String)
047     * @see ParameterDescriptorGroup#descriptor(String)
048     */
049    public class ParameterNotFoundException extends IllegalArgumentException {
050        /**
051         * Serial number for inter-operability with different versions.
052         */
053        private static final long serialVersionUID = -8074834945993975175L;
054    
055        /**
056         * The invalid parameter name.
057         */
058        private final String parameterName;
059    
060        /**
061         * Creates an exception with the specified message and parameter name.
062         *
063         * @param message The detail message. The detail message is saved for
064         *        later retrieval by the {@link #getMessage()} method.
065         * @param parameterName The name of the parameter which was required but not found.
066         */
067        public ParameterNotFoundException(String message, String parameterName) {
068            super(message);
069            this.parameterName = parameterName;
070        }
071    
072        /**
073         * Returns the name of the parameter which was required but not found.
074         *
075         * @return The required parameter name.
076         */
077        public String getParameterName() {
078            return parameterName;
079        }
080    }