Package com.solibri.smc.api.settings

Class BooleanSetting

java.lang.Object

com.solibri.smc.api.settings.BooleanSetting

All Implemented Interfaces:

Setting<Boolean>

public abstract class BooleanSetting
extends Object
implements Setting<Boolean>

The intended base class for Boolean valued custom settings.

Since:

9.10.8

Constructor Summary

Constructors

Constructor	Description
BooleanSetting()

Method Summary

Modifier and Type	Method	Description
Boolean	getValue()	Returns the current value of the setting.
Optional<String>	invalidReason(Boolean value)	The default is that either choice is valid.
void	setValue(Boolean 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 Details

BooleanSetting

public BooleanSetting()

Method Details

getValue

public Boolean 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<Boolean>

Returns:

the value

setValue

public void setValue(Boolean value)

Description copied from interface: Setting

Sets the value of the setting.

Specified by:

setValue in interface Setting<Boolean>

Parameters:

value - the value to be set

invalidReason

public Optional<String> invalidReason(Boolean value)

The default is that either choice is valid.

Specified by:

invalidReason in interface Setting<Boolean>

Parameters:

value - the value to be checked for validity

Returns:

true if the given value is valid, false otherwise