1 /*
2 * Licensed to the Hipparchus project 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 Hipparchus project 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 * https://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.hipparchus.ode;
18
19 import java.util.ArrayList;
20 import java.util.Collection;
21 import java.util.Collections;
22 import java.util.List;
23
24 import org.hipparchus.exception.MathIllegalArgumentException;
25
26 /** This abstract class provides boilerplate parameters list.
27 *
28 */
29
30 public abstract class AbstractParameterizable implements Parameterizable {
31
32 /** List of the parameters names. */
33 private final List<String> parametersNames;
34
35 /** Simple constructor.
36 * @param names names of the supported parameters
37 */
38 protected AbstractParameterizable(final String ... names) {
39 parametersNames = new ArrayList<>();
40 Collections.addAll(parametersNames, names);
41 }
42
43 /** Simple constructor.
44 * @param names names of the supported parameters
45 */
46 protected AbstractParameterizable(final Collection<String> names) {
47 parametersNames = new ArrayList<>();
48 parametersNames.addAll(names);
49 }
50
51 /** {@inheritDoc} */
52 @Override
53 public List<String> getParametersNames() {
54 return parametersNames;
55 }
56
57 /** {@inheritDoc} */
58 @Override
59 public boolean isSupported(final String name) {
60 for (final String supportedName : parametersNames) {
61 if (supportedName.equals(name)) {
62 return true;
63 }
64 }
65 return false;
66 }
67
68 /** Check if a parameter is supported and throw an IllegalArgumentException if not.
69 * @param name name of the parameter to check
70 * @exception MathIllegalArgumentException if the parameter is not supported
71 * @see #isSupported(String)
72 */
73 public void complainIfNotSupported(final String name)
74 throws MathIllegalArgumentException {
75 if (!isSupported(name)) {
76 throw new MathIllegalArgumentException(LocalizedODEFormats.UNKNOWN_PARAMETER, name);
77 }
78 }
79
80 }