Package com.solibri.smc.api.settings

Class DoubleSetting

java.lang.Object

com.solibri.smc.api.settings.DoubleSetting

All Implemented Interfaces:

Setting<Double>

public abstract class DoubleSetting
extends Object
implements Setting<Double>

The intended base class for Double valued custom settings.

Since:

9.10.8

Constructor Summary

Constructors

Constructor	Description
DoubleSetting()

Method Summary

Modifier and Type	Method	Description
Double	getValue()	Returns the current value of the setting.
Optional<String>	invalidReason(Double value)	The default is that any possible double is valid.
void	setValue(Double value)	Sets the value of the setting.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.solibri.smc.api.settings.Setting

getDefaultValue, getDescription, getName, getUniqueId

Constructor Detail

DoubleSetting

public DoubleSetting()

Method Detail

getValue

public Double getValue()

Description copied from interface: Setting

Returns the current value of the setting. This returns the new value of the setting immediately after it has been changed, but note that it is up to the users of settings to decide if the new value takes effect immediately or after a restart.

Specified by:

getValue in interface Setting<Double>

Returns:

the value

setValue

public void setValue(Double value)

Description copied from interface: Setting

Sets the value of the setting.

Specified by:

setValue in interface Setting<Double>

Parameters:

value - the value to be set

invalidReason

public Optional<String> invalidReason(Double value)

The default is that any possible double is valid.

Specified by:

invalidReason in interface Setting<Double>

Parameters:

value - the value to be checked for validity

Returns:

true if the given value is valid, false otherwise