Interface SettingsAgent
public interface SettingsAgent
Agent providing means to durably store job related settings.
- Since:
- 5.2.14
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic class
Exception stating that there is no setting with a requested name. -
Field Summary
Modifier and TypeFieldDescriptionstatic final SpecialistType<SettingsAgent>
Agent providing means to durably store job related settings. -
Method Summary
Modifier and TypeMethodDescriptionLoad some setting stored with the given name.void
Remove a setting having the given name.void
store
(@NotNull String name, @Nullable Serializable value) Store some setting value by the given name.
-
Field Details
-
TYPE
Agent providing means to durably store job related settings.- Since:
- 5.2.14
-
-
Method Details
-
load
Load some setting stored with the given name.- Parameters:
name
- The setting's name.- Returns:
- The setting's value.
- Throws:
SettingsAgent.NoSuchSettingException
- Since:
- 5.2.14
-
store
Store some setting value by the given name.- Parameters:
name
- The setting's name.value
- The setting's value.- Since:
- 5.2.14
-
remove
Remove a setting having the given name. If no setting by the given name exists, the call will be ignored.- Parameters:
name
- The setting's name.- Since:
- 5.2.14
-