summaryrefslogtreecommitdiff
path: root/src/main/java/org/apache/commons/math3/ode/AbstractParameterizable.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/main/java/org/apache/commons/math3/ode/AbstractParameterizable.java')
-rw-r--r--src/main/java/org/apache/commons/math3/ode/AbstractParameterizable.java81
1 files changed, 81 insertions, 0 deletions
diff --git a/src/main/java/org/apache/commons/math3/ode/AbstractParameterizable.java b/src/main/java/org/apache/commons/math3/ode/AbstractParameterizable.java
new file mode 100644
index 0000000..8b0a27e
--- /dev/null
+++ b/src/main/java/org/apache/commons/math3/ode/AbstractParameterizable.java
@@ -0,0 +1,81 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.commons.math3.ode;
+
+import java.util.ArrayList;
+import java.util.Collection;
+
+/**
+ * This abstract class provides boilerplate parameters list.
+ *
+ * @since 3.0
+ */
+public abstract class AbstractParameterizable implements Parameterizable {
+
+ /** List of the parameters names. */
+ private final Collection<String> parametersNames;
+
+ /**
+ * Simple constructor.
+ *
+ * @param names names of the supported parameters
+ */
+ protected AbstractParameterizable(final String... names) {
+ parametersNames = new ArrayList<String>();
+ for (final String name : names) {
+ parametersNames.add(name);
+ }
+ }
+
+ /**
+ * Simple constructor.
+ *
+ * @param names names of the supported parameters
+ */
+ protected AbstractParameterizable(final Collection<String> names) {
+ parametersNames = new ArrayList<String>();
+ parametersNames.addAll(names);
+ }
+
+ /** {@inheritDoc} */
+ public Collection<String> getParametersNames() {
+ return parametersNames;
+ }
+
+ /** {@inheritDoc} */
+ public boolean isSupported(final String name) {
+ for (final String supportedName : parametersNames) {
+ if (supportedName.equals(name)) {
+ return true;
+ }
+ }
+ return false;
+ }
+
+ /**
+ * Check if a parameter is supported and throw an IllegalArgumentException if not.
+ *
+ * @param name name of the parameter to check
+ * @exception UnknownParameterException if the parameter is not supported
+ * @see #isSupported(String)
+ */
+ public void complainIfNotSupported(final String name) throws UnknownParameterException {
+ if (!isSupported(name)) {
+ throw new UnknownParameterException(name);
+ }
+ }
+}