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