Module org.refcodes.observer

Package org.refcodes.observer

Interface Observers<O,B extends Observers<O,B>>

Type Parameters:

O - the generic type

B - The builder to return in order to be able to apply multiple build operations.

public interface Observers<O,B extends Observers<O,B>>

Provides methods to manage all subscribed Observer instances as a whole and is intended as an extension of the Observable interface.

Method Summary

Modifier and Type	Method	Description
default void	disableObservers()	Disables all observables.
default void	enableObservers()	Enables all observables.
boolean	isObserversActive()	Returns true when all Observer instances are theoretically active (the instance may also decide by itself), else false.
Iterator<O>	observers()	Returns an Iterator with the registered observers.
void	setObserversActive(boolean isActive)	Enables or disables all Observer instances.
B	withDisableObservers()	Builder method for the disableObservers() operation.
B	withEnableObservers()	Builder method for the enableObservers() operation.
B	withObserversActive(boolean isActive)	Builder method for the setObserversActive(boolean) operation.

Method Details

setObserversActive

void setObserversActive(boolean isActive)

Enables or disables all Observer instances.

Parameters:

isActive - When true then Request-Correlation is enabled, else disabled.

withObserversActive

B withObserversActive(boolean isActive)

Builder method for the setObserversActive(boolean) operation.

Parameters:

isActive - When true then Request-Correlation is enabled, else disabled.

Returns:

The builder for applying multiple build operations.

enableObservers

default void enableObservers()

Enables all observables.

withEnableObservers

B withEnableObservers()

Builder method for the enableObservers() operation.

Returns:

The builder for applying multiple build operations.

disableObservers

default void disableObservers()

Disables all observables.

isObserversActive

boolean isObserversActive()

Returns true when all Observer instances are theoretically active (the instance may also decide by itself), else false.

Returns:

True when active, false when inactive (disabled).

withDisableObservers

B withDisableObservers()

Builder method for the disableObservers() operation.

Returns:

The builder for applying multiple build operations.

observers

Iterator<O> observers()

Returns an Iterator with the registered observers.

Returns:

The according Iterator.