Interface SettingsAgent


public interface SettingsAgent
Agent providing means to durably store job related settings.
Since:
5.2.14
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    Exception stating that there is no setting with a requested name.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    Agent providing means to durably store job related settings.
  • Method Summary

    Modifier and Type
    Method
    Description
    load(@NotNull String name)
    Load some setting stored with the given name.
    void
    remove(@NotNull String name)
    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

  • Method Details

    • load

      Serializable load(@NotNull @NotNull String name) throws SettingsAgent.NoSuchSettingException
      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

      void store(@NotNull @NotNull String name, @Nullable @Nullable Serializable value)
      Store some setting value by the given name.
      Parameters:
      name - The setting's name.
      value - The setting's value.
      Since:
      5.2.14
    • remove

      void remove(@NotNull @NotNull String name)
      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