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