001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one or more
003     * contributor license agreements.  See the NOTICE file distributed with
004     * this work for additional information regarding copyright ownership.
005     * The ASF licenses this file to You under the Apache License, Version 2.0
006     * (the "License"); you may not use this file except in compliance with
007     * the License.  You may obtain a copy of the License at
008     *
009     *      http://www.apache.org/licenses/LICENSE-2.0
010     *
011     * Unless required by applicable law or agreed to in writing, software
012     * distributed under the License is distributed on an "AS IS" BASIS,
013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     * See the License for the specific language governing permissions and
015     * limitations under the License.
016     */
017    package org.apache.commons.math3.ode;
018    
019    import org.apache.commons.math3.exception.MathIllegalArgumentException;
020    import org.apache.commons.math3.exception.util.LocalizedFormats;
021    
022    /**
023     * Exception to be thrown when a parameter is unknown.
024     *
025     * @since 3.1
026     * @version $Id: UnknownParameterException.java 1416643 2012-12-03 19:37:14Z tn $
027     */
028    public class UnknownParameterException extends MathIllegalArgumentException {
029    
030        /** Serializable version Id. */
031        private static final long serialVersionUID = 20120902L;
032    
033        /** Parameter name. */
034        private final String name;
035    
036        /**
037         * Construct an exception from the unknown parameter.
038         *
039         * @param name parameter name.
040         */
041        public UnknownParameterException(final String name) {
042            super(LocalizedFormats.UNKNOWN_PARAMETER);
043            this.name = name;
044        }
045    
046        /**
047         * @return the name of the unknown parameter.
048         */
049        public String getName() {
050            return name;
051        }
052    
053    }