Package dev.getelements.elements.sdk.spi

Class RootElementRegistry

java.lang.Object

dev.getelements.elements.sdk.spi.RootElementRegistry

All Implemented Interfaces:

ElementRegistry, MutableElementRegistry, AutoCloseable

public class RootElementRegistry
extends Object
implements MutableElementRegistry

Implements ElementRegistry at the root level with no parent. This should be used by the application at the top-level. Note that when registering

Field Summary

Fields inherited from interface dev.getelements.elements.sdk.ElementRegistry

ROOT

Constructor Summary

Constructors

Constructor	Description
RootElementRegistry()
RootElementRegistry(Supplier<Stream<Element>> parentElementSupplier)

Method Summary

Modifier and Type	Method	Description
void	close()	Closes all Element instances within this ElementRegistry and closes the registry itself.
MutableElementRegistry	newSubordinateRegistry()	Returns a new subordinate registry.
Subscription	onClose(Consumer<ElementRegistry> onClose)	Adds a Consumer to this ElementRegistry which will get called when it is closed.
Subscription	onEvent(Consumer<Event> onEvent)	Adds a Consumer to this ElementRegistry which will get called when an Event is sourced from an Element within this registry.
void	publish(Event event)	Publishes an Event to the Element instances within this ElementRegistry.
Element	register(Element element)	Registers an Element to this instance, making it available to all child and sibling Elements.
Stream<Element>	stream()	Streams all Element isntances in this ElementRegistry.
boolean	unregister(Element element)	Unregisters an Element, provided it was previously registered.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface dev.getelements.elements.sdk.ElementRegistry

find

Methods inherited from interface dev.getelements.elements.sdk.MutableElementRegistry

register

Constructor Details

RootElementRegistry

public RootElementRegistry()

RootElementRegistry

public RootElementRegistry(Supplier<Stream<Element>> parentElementSupplier)

Method Details

stream

public Stream<Element> stream()

Description copied from interface: ElementRegistry

Streams all Element isntances in this ElementRegistry.

Specified by:

stream in interface ElementRegistry

Returns:

the Stream of Elements

register

public Element register(Element element)

Description copied from interface: MutableElementRegistry

Registers an Element to this instance, making it available to all child and sibling Elements.

Specified by:

register in interface MutableElementRegistry

Parameters:

element - the ElementLoader to supply the Element

unregister

public boolean unregister(Element element)

Description copied from interface: MutableElementRegistry

Unregisters an Element, provided it was previously registered.

Specified by:

unregister in interface MutableElementRegistry

Returns:

if the Element existed, and was successfully removed.

newSubordinateRegistry

public MutableElementRegistry newSubordinateRegistry()

Description copied from interface: ElementRegistry

Returns a new subordinate registry. This registry will be linked to this registry and inherit all currently registered Elements contained in. Searching the new subordinate registry will make all registered Elements available that are available to this registry. The returned MutableElementRegistry will receive events from this ElementRegistry and forward them along to all Elements therein. This allows an Element to load private instances as it sees fit without affecting its parent's hierarchy and thus enforcing encapsulation.

Specified by:

newSubordinateRegistry in interface ElementRegistry

Returns:

a new subordinate

publish

public void publish(Event event)

Description copied from interface: ElementRegistry

Publishes an Event to the Element instances within this ElementRegistry.

Specified by:

publish in interface ElementRegistry

Parameters:

event - the event

onEvent

public Subscription onEvent(Consumer<Event> onEvent)

Description copied from interface: ElementRegistry

Adds a Consumer to this ElementRegistry which will get called when an Event is sourced from an Element within this registry.

Specified by:

onEvent in interface ElementRegistry

Parameters:

onEvent - the event consumer

Returns:

a Subscription to the event

onClose

public Subscription onClose(Consumer<ElementRegistry> onClose)

Description copied from interface: ElementRegistry

Adds a Consumer to this ElementRegistry which will get called when it is closed.

Specified by:

onClose in interface ElementRegistry

Parameters:

onClose - the on close consumer

Returns:

a Subscription to the event

close

public void close()

Description copied from interface: ElementRegistry

Closes all Element instances within this ElementRegistry and closes the registry itself.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ElementRegistry