View Javadoc
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.Collection;
20  
21  /** This interface enables to process any parameterizable object.
22   *
23   * @since 3.0
24   */
25  
26  public interface Parameterizable {
27  
28      /** Get the names of the supported parameters.
29       * @return parameters names
30       * @see #isSupported(String)
31       */
32      Collection<String> getParametersNames();
33  
34      /** Check if a parameter is supported.
35       * <p>Supported parameters are those listed by {@link #getParametersNames()}.</p>
36       * @param name parameter name to check
37       * @return true if the parameter is supported
38       * @see #getParametersNames()
39       */
40      boolean isSupported(String name);
41  }