Package dev.getelements.elements.sdk

Interface ElementRegistry

All Superinterfaces:

AutoCloseable

All Known Subinterfaces:

MutableElementRegistry

All Known Implementing Classes:

ElementScopedElementRegistry, RootElementRegistry

public interface ElementRegistry
extends AutoCloseable

Represents a registry for Element instances. Inside an Element, there is a shared registry available by using the ServiceLoader to find an instance of ElementRegistrySupplier. This provides access to registries in a hierarchy while allowing for visibility into other Element instances. When searching the hierarchy, by name, the registry searches for all registered at its level, and then up to the parent level and so forth until the root level. The Stream returned from the find(String) method will always return the closest first. Note, instances of ElementRegistry must be thread-safe and may implement thread safety using a locking strategy.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ROOT	A name binding for the root ElementRegistry

Method Summary

Modifier and Type	Method	Description
void	close()	Closes all Element instances within this ElementRegistry and closes the registry itself.
default Stream<Element>	find(String name)	Gets all Element instances which was registered to this ElementRegistry specifying the name of the Element
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.
Stream<Element>	stream()	Streams all Element isntances in this ElementRegistry.

Field Details

ROOT

static final String ROOT

A name binding for the root ElementRegistry

See Also:

• Constant Field Values

Method Details

stream

Stream<Element> stream()

Streams all Element isntances in this ElementRegistry.

Returns:

the Stream of Elements

find

default Stream<Element> find(String name)

Gets all Element instances which was registered to this ElementRegistry specifying the name of the Element

Parameters:

name - the name of the Element

Returns:

an Optional of the element

newSubordinateRegistry

MutableElementRegistry newSubordinateRegistry()

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.

Returns:

a new subordinate

publish

void publish(Event event)

Publishes an Event to the Element instances within this ElementRegistry.

Parameters:

event - the event

onEvent

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.

Parameters:

onEvent - the event consumer

Returns:

a Subscription to the event

onClose

Subscription onClose(Consumer<ElementRegistry> onClose)

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

Parameters:

onClose - the on close consumer

Returns:

a Subscription to the event

close

void close()

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

Specified by:

close in interface AutoCloseable