Package dev.getelements.elements.sdk

Interface ElementLoaderFactory

All Known Implementing Classes:

DefaultElementLoaderFactory

public interface ElementLoaderFactory

The ElementLoader factory. This loads an instance of a Element on-demand.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ElementLoaderFactory.ClassLoaderConstructor	A constructor type for a ClassLoader.

Method Summary

Modifier and Type	Method	Description
Optional<ElementDefinitionRecord>	findElementDefinitionRecord(ClassLoader classLoader, Attributes attributes, Predicate<ElementDefinitionRecord> selector)	Finds the Element name, this will find the ElementRecord associated with it, throwing an exception if it is unable to find the ElementDefinition annotation.
static ElementLoaderFactory	getDefault()	Gets a default ElementLoaderFactory via the ServiceLoader interface.
ElementRecord	getElementRecordFromPackage(Attributes attributes, Package aPackage)	Given the Package, this will find the ElementRecord associated with it, throwing an exception if it is unable to find the ElementDefinition annotation.
Stream<ElementServiceRecord>	getExposedServices(Package aPackage)	Scans the supplied Package for specified
default ElementLoader	getIsolatedLoader(Attributes attributes, ClassLoader baseClassLoader, ElementLoaderFactory.ClassLoaderConstructor classLoaderCtor)	Scans the classpath, using the supplied ClassLoader, for Element instances.
ElementLoader	getIsolatedLoader(Attributes attributes, ClassLoader baseClassLoader, ElementLoaderFactory.ClassLoaderConstructor classLoaderCtor, Predicate<ElementDefinitionRecord> selector)	Scans the classpath, using the supplied ClassLoader, for Element instances.
ElementLoader	getSharedLoader(ElementRecord elementRecord, ServiceLocator serviceLocator)	Scans the supplied Package for Element instances with the supplied Package.

Method Details

getIsolatedLoader

default ElementLoader getIsolatedLoader(Attributes attributes,
 ClassLoader baseClassLoader,
 ElementLoaderFactory.ClassLoaderConstructor classLoaderCtor)

Scans the classpath, using the supplied ClassLoader, for Element instances. If the element is found, then this returns an instance of ElementLoader which can be used to instantiate the Element. With the supplied ClassLoader (from the supplied Function there must exist exactly one ElementDefinition.

Results in a ElementType.ISOLATED_CLASSPATH Element

Parameters:

attributes - the attributes to use

baseClassLoader - the base ClassLoader, this will be ultimately be the parent for Element's ClassLoader instance.

classLoaderCtor - the ClassLoader classloader

Returns:

the ElementLoader

getIsolatedLoader

ElementLoader getIsolatedLoader(Attributes attributes,
 ClassLoader baseClassLoader,
 ElementLoaderFactory.ClassLoaderConstructor classLoaderCtor,
 Predicate<ElementDefinitionRecord> selector)

Scans the classpath, using the supplied ClassLoader, for Element instances. If the element is found, then this returns an instance of ElementLoader which can be used to instantiate the Element. With the supplied ClassLoader (from the supplied Function there must exist exactly one ElementDefinition.

Results in a ElementType.ISOLATED_CLASSPATH Element

Parameters:

attributes - the attributes to use

baseClassLoader - the base ClassLoader, this will be ultimately be the parent for Element's ClassLoader instance.

classLoaderCtor - the ClassLoader classloader

selector - a Predicate to select a single ElementDefinitionRecord to load

Returns:

the ElementLoader

getSharedLoader

ElementLoader getSharedLoader(ElementRecord elementRecord,
 ServiceLocator serviceLocator)

Scans the supplied Package for Element instances with the supplied Package. This performs no classloader isolation and while multiple ElementDefinition instances may be on the current classpath, only one may exist on the supplied Package passed to this method.

Results in a ElementType.SHARED_CLASSPATH Element

Parameters:

elementRecord - the Package to the Element

serviceLocator - a pre-configured ServiceLocator, from an existing source

Returns:

the Element, loaded

findElementDefinitionRecord

Optional<ElementDefinitionRecord> findElementDefinitionRecord(ClassLoader classLoader,
 Attributes attributes,
 Predicate<ElementDefinitionRecord> selector)

Finds the Element name, this will find the ElementRecord associated with it, throwing an exception if it is unable to find the ElementDefinition annotation. Used in constructing shared elements.

Parameters:

classLoader -

attributes - the attributes to use

selector - a Predicate to select a single ElementDefinitionRecord to load

Returns:

the ElementRecord

getElementRecordFromPackage

ElementRecord getElementRecordFromPackage(Attributes attributes,
 Package aPackage)

Given the Package, this will find the ElementRecord associated with it, throwing an exception if it is unable to find the ElementDefinition annotation. Used in constructing shared elements.

Parameters:

attributes - the attributes to use

aPackage - the package to scan

Returns:

the ElementRecord

getExposedServices

Stream<ElementServiceRecord> getExposedServices(Package aPackage)

Scans the supplied Package for specified

Parameters:

aPackage - a package to scan

Returns:

a Stream of all ElementServiceRecords exposed by the Element

getDefault

static ElementLoaderFactory getDefault()

Gets a default ElementLoaderFactory via the ServiceLoader interface.

Returns:

the ElementLoaderFactory