Interface TroubleAware
- All Known Subinterfaces:
TroubleListener
- All Known Implementing Classes:
TroubleAwareAdapter
,TroubleListenerAdapter
public interface TroubleAware
Interface that objects can implement to be notified when a trouble
is added / removed where the object is in the impacted list of the
trouble. Provides an easy way to react to changes in trouble state
without using global listeners.
- Since:
- 1.0
- Version:
- 2022-09-17
-
Method Summary
Modifier and TypeMethodDescriptiondefault void
onTroubleAdded
(Trouble trouble) Called when a trouble is added.default void
onTroubleRemoved
(Trouble trouble) Called when a trouble is removed.default void
onTroubleResolved
(Trouble trouble, boolean success) Called when a trouble completes resolve processing whether it is successful or not.
-
Method Details
-
onTroubleAdded
Called when a trouble is added.- Parameters:
trouble
- the trouble being added
-
onTroubleResolved
Called when a trouble completes resolve processing whether it is successful or not.- Parameters:
trouble
- the trouble being resolvedsuccess
- true if resolved successfully
-
onTroubleRemoved
Called when a trouble is removed.- Parameters:
trouble
- the trouble being removed
-