View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.commons.math4.legacy.ode;
18  
19  import org.apache.commons.math4.legacy.exception.MathIllegalArgumentException;
20  import org.apache.commons.math4.legacy.exception.util.LocalizedFormats;
21  
22  /**
23   * Exception to be thrown when a parameter is unknown.
24   *
25   * @since 3.1
26   */
27  public class UnknownParameterException extends MathIllegalArgumentException {
28  
29      /** Serializable version Id. */
30      private static final long serialVersionUID = 20120902L;
31  
32      /** Parameter name. */
33      private final String name;
34  
35      /**
36       * Construct an exception from the unknown parameter.
37       *
38       * @param name parameter name.
39       */
40      public UnknownParameterException(final String name) {
41          super(LocalizedFormats.UNKNOWN_PARAMETER, name);
42          this.name = name;
43      }
44  
45      /**
46       * @return the name of the unknown parameter.
47       */
48      public String getName() {
49          return name;
50      }
51  }