Top Description Fields Constructors Methods
org.apache.commons.math3.ode

public abstract Class AbstractParameterizable

extends Object
implements Parameterizable
Class Inheritance
All Implemented Interfaces
org.apache.commons.math3.ode.Parameterizable
Imports
java.util.ArrayList, .Collection
This abstract class provides boilerplate parameters list.
Since
3.0

Field Summary

Modifier and TypeField and Description
private final Collection<String>
parametersNames

List of the parameters names.

Constructor Summary

AccessConstructor and Description
protected
AbstractParameterizable(final String...
names of the supported parameters
names)

Simple constructor.

protected
AbstractParameterizable(final Collection<String>
names of the supported parameters
names)

Simple constructor.

Method Summary

Modifier and TypeMethod and Description
public void
complainIfNotSupported(final String
name of the parameter to check
name)

Check if a parameter is supported and throw an IllegalArgumentException if not.

public Collection<String>
getParametersNames()

Implements org.apache.commons.math3.ode.Parameterizable.getParametersNames.

Get the names of the supported parameters.

public boolean
isSupported(final String
parameter name to check
name)

Implements org.apache.commons.math3.ode.Parameterizable.isSupported.

Check if a parameter is supported.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

parametersNamesback to summary
private final Collection<String> parametersNames

List of the parameters names.

Constructor Detail

AbstractParameterizableback to summary
protected AbstractParameterizable(final String... names)

Simple constructor.

Parameters
names:String[]

names of the supported parameters

AbstractParameterizableback to summary
protected AbstractParameterizable(final Collection<String> names)

Simple constructor.

Parameters
names:Collection<String>

names of the supported parameters

Method Detail

complainIfNotSupportedback to summary
public void complainIfNotSupported(final String name) throws UnknownParameterException

Check if a parameter is supported and throw an IllegalArgumentException if not.

Parameters
name:String

name of the parameter to check

Exceptions
UnknownParameterException:
if the parameter is not supported
See Also
isSupported(String)
getParametersNamesback to summary
public Collection<String> getParametersNames()

Implements org.apache.commons.math3.ode.Parameterizable.getParametersNames.

Doc from org.apache.commons.math3.ode.Parameterizable.getParametersNames.

Get the names of the supported parameters.

Returns:Collection<String>

parameters names

isSupportedback to summary
public boolean isSupported(final String name)

Implements org.apache.commons.math3.ode.Parameterizable.isSupported.

Doc from org.apache.commons.math3.ode.Parameterizable.isSupported.

Check if a parameter is supported.

Supported parameters are those listed by getParametersNames().

Parameters
name:String

parameter name to check

Returns:boolean

true if the parameter is supported