Package dev.getelements.elements.sdk.spi

Class DefaultElementLoaderFactory

java.lang.Object

dev.getelements.elements.sdk.spi.DefaultElementLoaderFactory

All Implemented Interfaces:

ElementLoaderFactory

public class DefaultElementLoaderFactory
extends Object
implements ElementLoaderFactory

Nested Class Summary

Nested classes/interfaces inherited from interface dev.getelements.elements.sdk.ElementLoaderFactory

ElementLoaderFactory.ClassLoaderConstructor

Constructor Summary

Constructors

Constructor	Description
DefaultElementLoaderFactory()

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, return an empty optional if it is unable to find the ElementDefinition annotation.
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
ElementLoader	getIsolatedLoaderWithParent(Attributes attributes, ClassLoader baseClassLoader, ElementLoaderFactory.ClassLoaderConstructor classLoaderCtor, Element element, 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.

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.ElementLoaderFactory

findElementDefinitionRecord, getIsolatedLoader, getIsolatedLoader, getIsolatedLoader, getIsolatedLoader, getIsolatedLoaderWithParent

Constructor Details

DefaultElementLoaderFactory

public DefaultElementLoaderFactory()

Method Details

getIsolatedLoaderWithParent

public ElementLoader getIsolatedLoaderWithParent(Attributes attributes,
 ClassLoader baseClassLoader,
 ElementLoaderFactory.ClassLoaderConstructor classLoaderCtor,
 Element element,
 Predicate<ElementDefinitionRecord> selector)

Description copied from interface: ElementLoaderFactory

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 with the supplied Predicate.

Results in a ElementType.ISOLATED_CLASSPATH Element

The returned ElementLoader will use the Element's classpath with a filtered version of the supplied base ClassLoader as the parent classloader.

Specified by:

getIsolatedLoaderWithParent in interface ElementLoaderFactory

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

element - the parent Element to use for the classloader isolation, may be null indicating that isolation should exist for the bootstrap classpath only.

selector - a Predicate to select a single ElementDefinitionRecord to load

Returns:

the ElementLoader

findElementDefinitionRecord

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

Description copied from interface: ElementLoaderFactory

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

Specified by:

findElementDefinitionRecord in interface ElementLoaderFactory

Parameters:

classLoader - the classloader to scan

attributes - the attributes to use

selector - a Predicate to select a single ElementDefinitionRecord to load

Returns:

the ElementRecord

getElementRecordFromPackage

public ElementRecord getElementRecordFromPackage(Attributes attributes,
 Package aPackage)

Description copied from interface: ElementLoaderFactory

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.

Specified by:

getElementRecordFromPackage in interface ElementLoaderFactory

Parameters:

attributes - the attributes to use

aPackage - the package to scan

Returns:

the ElementRecord

getExposedServices

public Stream<ElementServiceRecord> getExposedServices(Package aPackage)

Description copied from interface: ElementLoaderFactory

Scans the supplied Package for specified

Specified by:

getExposedServices in interface ElementLoaderFactory

Parameters:

aPackage - a package to scan

Returns:

a Stream of all ElementServiceRecords exposed by the Element

getSharedLoader

public ElementLoader getSharedLoader(ElementRecord elementRecord,
 ServiceLocator serviceLocator)

Description copied from interface: ElementLoaderFactory

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

Specified by:

getSharedLoader in interface ElementLoaderFactory

Parameters:

elementRecord - the Package to the Element

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

Returns:

the Element, loaded