org.macroing.cit.configuration

Interface ConfigurationObserver

All Known Implementing Classes:

DoubleProperty, IntProperty, ObjectProperty

public interface ConfigurationObserver

A ConfigurationObserver observes changes made to a Configuration instance.

Since:

1.0.0

Author:

Jörgen Lundgren

Method Summary

Modifier and Type	Method and Description
default void	added(Configuration configuration) Called by the Configuration that this ConfigurationObserver instance was just added to.
void	objectSet(Configuration configuration, java.lang.String id, java.util.Optional<?> oldObject, java.util.Optional<?> newObject) Called by a Configuration when a new Object has been set for a given ID.
default void	removed(Configuration configuration) Called by the Configuration that this ConfigurationObserver instance was just removed from.

Method Detail

objectSet

void objectSet(Configuration configuration,
               java.lang.String id,
               java.util.Optional<?> oldObject,
               java.util.Optional<?> newObject)

Called by a Configuration when a new Object has been set for a given ID.

If either configuration, id, oldObject or newObject are null, a NullPointerException may be thrown. But no guarantees can be made for all implementations.

Parameters:

configuration - the Configuration that called this method

id - the ID of the Object

oldObject - an Optional that contains the old configuration value, if it was set

newObject - an Optional that contains the new configuration value, if it is set

Throws:

java.lang.NullPointerException - thrown if, and only if, either configuration, id, oldObject or newObject are null

added

default void added(Configuration configuration)

Called by the Configuration that this ConfigurationObserver instance was just added to.

If configuration is null, a NullPointerException may be thrown. But no guarantees can be made for all implementations. However, the default implementation will throw a NullPointerException if configuration is null

This method does nothing by default.

Parameters:

configuration - the Configuration that called this method

Throws:

java.lang.NullPointerException - thrown if, and only if, configuration is null

removed

default void removed(Configuration configuration)

Called by the Configuration that this ConfigurationObserver instance was just removed from.

If configuration is null, a NullPointerException may be thrown. But no guarantees can be made for all implementations. However, the default implementation will throw a NullPointerException if configuration is null

This method does nothing by default.

Parameters:

configuration - the Configuration that called this method

Throws:

java.lang.NullPointerException - thrown if, and only if, configuration is null