diff options
Diffstat (limited to 'src/main/java/org/apache/commons/math3/ode/Parameterizable.java')
-rw-r--r-- | src/main/java/org/apache/commons/math3/ode/Parameterizable.java | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/src/main/java/org/apache/commons/math3/ode/Parameterizable.java b/src/main/java/org/apache/commons/math3/ode/Parameterizable.java new file mode 100644 index 0000000..40371cb --- /dev/null +++ b/src/main/java/org/apache/commons/math3/ode/Parameterizable.java @@ -0,0 +1,46 @@ +/* + * 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.Collection; + +/** + * This interface enables to process any parameterizable object. + * + * @since 3.0 + */ +public interface Parameterizable { + + /** + * Get the names of the supported parameters. + * + * @return parameters names + * @see #isSupported(String) + */ + Collection<String> getParametersNames(); + + /** + * Check if a parameter is supported. + * + * <p>Supported parameters are those listed by {@link #getParametersNames()}. + * + * @param name parameter name to check + * @return true if the parameter is supported + * @see #getParametersNames() + */ + boolean isSupported(String name); +} |