Package com.solibri.smc.api.settings

Class StringSetting

java.lang.Object

com.solibri.smc.api.settings.StringSetting

All Implemented Interfaces:

Setting<String>

Direct Known Subclasses:

PasswordSetting

public abstract class StringSetting
extends Object
implements Setting<String>

The intended base class for String valued custom settings.

Since:

9.10.8

Constructor Summary

Constructors

Constructor	Description
StringSetting()

Method Summary

Modifier and Type	Method	Description
String	getValue()	Returns the current value of the setting.
Optional<String>	invalidReason(String value)	The default is that any possible string is valid.
boolean	isMultiLine()	Returns whether this string setting is multilined or not.
void	setValue(String 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

StringSetting

public StringSetting()

Method Details

getValue

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

Returns:

the value

setValue

public void setValue(String value)

Description copied from interface: Setting

Sets the value of the setting.

Specified by:

setValue in interface Setting<String>

Parameters:

value - the value to be set

invalidReason

public Optional<String> invalidReason(String value)

The default is that any possible string is valid.

Specified by:

invalidReason in interface Setting<String>

Parameters:

value - the value to be checked for validity

Returns:

true if the given value is valid, false otherwise

isMultiLine

public boolean isMultiLine()

Returns whether this string setting is multilined or not. Usually the setting is a single line setting, but sometimes free text input is needed and multiline string setting works better.

Returns:

true if the setting is a multiline setting

Since:

9.10.8