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 */
017package org.apache.commons.math3.ode;
018
019import org.apache.commons.math3.exception.MathIllegalArgumentException;
020import 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 */
027public class UnknownParameterException extends MathIllegalArgumentException {
028
029    /** Serializable version Id. */
030    private static final long serialVersionUID = 20120902L;
031
032    /** Parameter name. */
033    private final String name;
034
035    /**
036     * Construct an exception from the unknown parameter.
037     *
038     * @param name parameter name.
039     */
040    public UnknownParameterException(final String name) {
041        super(LocalizedFormats.UNKNOWN_PARAMETER);
042        this.name = name;
043    }
044
045    /**
046     * @return the name of the unknown parameter.
047     */
048    public String getName() {
049        return name;
050    }
051
052}