ObservableConfig (KamiCommon)

All Known Implementing Classes:: AbstractSubsystem, Feature, FeatureConfig, KamiConfig, KamiConfigExt, KamiPlugin, Module, ModuleConfig, SubsystemConfig

public interface ObservableConfig

Interface for classes that accept ConfigObserver registrations.

See registerConfigObserver(ConfigObserver).

Method Summary

Modifier and Type

Method

Description

boolean

registerConfigObserver(@NotNull ConfigObserver observer)

Registers an observer to this config (if not already registered)
Refer to the ConfigObserver docs for information on its lifecycle.

void

reloadObservableConfig()

Reload the backing config for this observable, notifying all registered observers of the change.

void

unregisterConfigObserver(@NotNull ConfigObserver observer)

Unregisters an observer from this config

void

unregisterConfigObservers()

Unregisters ALL observers from this config.
Intended for shutdown logic, but can be used at any time.

Method Details
- registerConfigObserver
  
  boolean registerConfigObserver(@NotNull @NotNull ConfigObserver observer)
  
  Registers an observer to this config (if not already registered)
  Refer to the ConfigObserver docs for information on its lifecycle.
  
  Returns:
  
  If the observer was successfully registered from this call (false if already registered)
- unregisterConfigObserver
  
  void unregisterConfigObserver(@NotNull @NotNull ConfigObserver observer)
  
  Unregisters an observer from this config
- unregisterConfigObservers
  
  void unregisterConfigObservers()
  
  Unregisters ALL observers from this config.
  Intended for shutdown logic, but can be used at any time.
- reloadObservableConfig
  
  void reloadObservableConfig()
  
  Reload the backing config for this observable, notifying all registered observers of the change.