Package net.officefloor.compile.impl.structure

Class SupplierNodeImpl

java.lang.Object

net.officefloor.compile.impl.structure.SupplierNodeImpl

All Implemented Interfaces:

Node, SupplierNode, PropertyConfigurable, OfficeSupplier, OfficeFloorSupplier

public class SupplierNodeImpl
extends java.lang.Object
implements SupplierNode

SupplierNode implementation.

Author:

Daniel Sagenschneider

Field Summary

Fields inherited from interface net.officefloor.compile.internal.structure.SupplierNode

TYPE

Constructor Summary

Constructors

Constructor	Description
SupplierNodeImpl(java.lang.String supplierName, OfficeNode officeNode, OfficeFloorNode officeFloorNode, NodeContext context)	Instantiate.

Method Summary

Modifier and Type	Method	Description
void	addProperty(java.lang.String name, java.lang.String value)	Adds a Property to configure the item.
void	autoWireObjects(AutoWirer<LinkObjectNode> autoWirer, OfficeNode office, CompileContext compileContext)	Auto-wires the SupplierThreadLocalNode instances that are unlinked.
void	buildSupplier(OfficeBuilder officeBuilder, CompileContext compileContext)	Builds the SupplierThreadLocal instances for the SupplierSource.
boolean	ensureNoThreadLocals(CompileContext compileContext)	Ensures there are no SupplierThreadLocalNode and ThreadSynchroniserFactory instances.
Node[]	getChildNodes()	Obtains the child Node instances.
InternalSupplier[]	getInternalSuppliers()	Obtains the InternalSupplier instances.
java.lang.String	getLocation()	Obtains the location of the Node.
<S> S	getManagedObjectSource(java.lang.String qualifier, java.lang.String type, java.util.function.Function<SuppliedManagedObjectSourceNode,S> factory)	Obtains the OfficeFloorManagedObjectSource / OfficeManagedObjectSource.
java.lang.String	getNodeName()	Obtains the name of the Node.
java.lang.String	getNodeType()	Obtains the Node type.
OfficeFloorManagedObjectSource	getOfficeFloorManagedObjectSource(java.lang.String managedObjectSourceName, java.lang.String qualifier, java.lang.String type)	Obtains the OfficeFloorManagedObjectSource.
OfficeFloorNode	getOfficeFloorNode()	Obtains the parent OfficeFloorNode.
java.lang.String	getOfficeFloorSupplierName()	Obtains the name of this OfficeFloorSupplier.
OfficeFloorSupplierThreadLocal	getOfficeFloorSupplierThreadLocal(java.lang.String qualifier, java.lang.String type)	Obtains the OfficeFloorSupplierThreadLocal.
OfficeManagedObjectSource	getOfficeManagedObjectSource(java.lang.String managedObjectSourceName, java.lang.String qualifier, java.lang.String type)	Obtains the OfficeManagedObjectSource.
OfficeNode	getOfficeNode()	Obtains the parent OfficeNode.
java.lang.String	getOfficeSupplierName()	Obtains the name of this OfficeSupplier.
OfficeSupplierThreadLocal	getOfficeSupplierThreadLocal(java.lang.String qualifier, java.lang.String type)	Obtains the OfficeSupplierThreadLocal.
Node	getParentNode()	Obtains the Node containing this Node.
void	initialise(java.lang.String supplierSourceClassName, SupplierSource supplierSource)	Initialises the SupplierNode.
boolean	isInitialised()	Indicates if the Node has been initialised.
void	loadAutoWireExtensions(AutoWirer<ManagedObjectExtensionNode> autoWirer, ManagedObjectSourceVisitor managedObjectSourceVisitor, CompileContext compileContext)	Loads the SuppliedManagedObjectSourceNode instances as ManagedObjectExtensionNode instances to the AutoWirer.
void	loadAutoWireObjects(AutoWirer<LinkObjectNode> autoWirer, ManagedObjectSourceVisitor managedObjectSourceVisitor, CompileContext compileContext)	Loads the SuppliedManagedObjectSourceNode instances as ManagedObjectNode instances to the AutoWirer.
InitialSupplierType	loadInitialSupplierType(boolean isLoadingType)	Loads the InitialSupplierType.
SupplierType	loadSupplierType(CompileContext compileContext, boolean isLoadingType, AvailableType[] availableTypes)	Loads the SupplierType.
void	registerAsPossibleMBean(CompileContext compileContext)	Registers as a possible MBean.
boolean	sourceComplete(CompileContext compileContext)	Flags sourcing functionality complete.
boolean	sourceSupplier(CompileContext compileContext)	Sources the SupplierThreadLocal instances.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.officefloor.compile.internal.structure.Node

getQualifiedName, getQualifiedName

Constructor Detail

SupplierNodeImpl

public SupplierNodeImpl(java.lang.String supplierName,
                        OfficeNode officeNode,
                        OfficeFloorNode officeFloorNode,
                        NodeContext context)

Instantiate.

Parameters:

supplierName - Name of the OfficeFloorSupplier.

officeNode - OfficeNode.

officeFloorNode - OfficeFloorNode.

context - NodeContext.

Method Detail

getManagedObjectSource

public <S> S getManagedObjectSource(java.lang.String qualifier,
                                    java.lang.String type,
                                    java.util.function.Function<SuppliedManagedObjectSourceNode,S> factory)

Obtains the OfficeFloorManagedObjectSource / OfficeManagedObjectSource.

Type Parameters:

S - OfficeFloorManagedObjectSource / OfficeManagedObjectSource type.

Parameters:

qualifier - Qualifier. May be null.

type - Type.

factory - Factory to create the OfficeFloorManagedObjectSource / OfficeManagedObjectSource.

Returns:

OfficeFloorManagedObjectSource / OfficeManagedObjectSource.

getNodeName

public java.lang.String getNodeName()

Description copied from interface: Node

Obtains the name of the Node.

Specified by:

getNodeName in interface Node

Returns:

Name of the Node.

getNodeType

public java.lang.String getNodeType()

Description copied from interface: Node

Obtains the Node type.

Specified by:

getNodeType in interface Node

Returns:

Node type.

getLocation

public java.lang.String getLocation()

Description copied from interface: Node

Obtains the location of the Node.

Specified by:

getLocation in interface Node

Returns:

Location of the Node. May be null if Node does not support a location.

getParentNode

public Node getParentNode()

Description copied from interface: Node

Obtains the Node containing this Node.

Specified by:

getParentNode in interface Node

Returns:

Node containing this Node.

getChildNodes

public Node[] getChildNodes()

Description copied from interface: Node

Obtains the child Node instances.

Specified by:

getChildNodes in interface Node

Returns:

Child Node instances.

isInitialised

public boolean isInitialised()

Description copied from interface: Node

Indicates if the Node has been initialised. Node instances should only be initialised once. Initialising the Node twice is an issue.

Specified by:

isInitialised in interface Node

Returns:

true if initialised.

initialise

public void initialise(java.lang.String supplierSourceClassName,
                       SupplierSource supplierSource)

Description copied from interface: SupplierNode

Initialises the SupplierNode.

Specified by:

initialise in interface SupplierNode

Parameters:

supplierSourceClassName - Class name of the SupplierSource.

supplierSource - Optional instantiated SupplierSource. May be null.

getOfficeFloorSupplierName

public java.lang.String getOfficeFloorSupplierName()

Description copied from interface: OfficeFloorSupplier

Obtains the name of this OfficeFloorSupplier.

Specified by:

getOfficeFloorSupplierName in interface OfficeFloorSupplier

Returns:

Name of this OfficeFloorSupplier.

addProperty

public void addProperty(java.lang.String name,
                        java.lang.String value)

Description copied from interface: PropertyConfigurable

Adds a Property to configure the item.

Specified by:

addProperty in interface PropertyConfigurable

Parameters:

name - Name of Property.

value - Value of Property.

getOfficeFloorSupplierThreadLocal

public OfficeFloorSupplierThreadLocal getOfficeFloorSupplierThreadLocal(java.lang.String qualifier,
                                                                        java.lang.String type)

Description copied from interface: OfficeFloorSupplier

Obtains the OfficeFloorSupplierThreadLocal.

Specified by:

getOfficeFloorSupplierThreadLocal in interface OfficeFloorSupplier

Parameters:

qualifier - Qualifier of the required ManagedObject. May be null to match only on type.

type - Type of object required for the OfficeFloorSupplierThreadLocal.

Returns:

OfficeFloorSupplierThreadLocal.

getOfficeFloorManagedObjectSource

public OfficeFloorManagedObjectSource getOfficeFloorManagedObjectSource(java.lang.String managedObjectSourceName,
                                                                        java.lang.String qualifier,
                                                                        java.lang.String type)

Description copied from interface: OfficeFloorSupplier

Obtains the OfficeFloorManagedObjectSource.

Specified by:

getOfficeFloorManagedObjectSource in interface OfficeFloorSupplier

Parameters:

managedObjectSourceName - Name of the OfficeFloorManagedObjectSource.

qualifier - Qualifier on the object type. May be null to match only on type.

type - Type of object required from the OfficeFloorSupplier.

Returns:

OfficeFloorManagedObjectSource.

getOfficeSupplierName

public java.lang.String getOfficeSupplierName()

Description copied from interface: OfficeSupplier

Obtains the name of this OfficeSupplier.

Specified by:

getOfficeSupplierName in interface OfficeSupplier

Returns:

Name of this OfficeSupplier.

getOfficeSupplierThreadLocal

public OfficeSupplierThreadLocal getOfficeSupplierThreadLocal(java.lang.String qualifier,
                                                              java.lang.String type)

Description copied from interface: OfficeSupplier

Obtains the OfficeSupplierThreadLocal.

Specified by:

getOfficeSupplierThreadLocal in interface OfficeSupplier

Parameters:

qualifier - Qualifier of the required ManagedObject. May be null to match only on type.

type - Type of object required for the OfficeSupplierThreadLocal.

Returns:

OfficeSupplierThreadLocal.

getOfficeManagedObjectSource

public OfficeManagedObjectSource getOfficeManagedObjectSource(java.lang.String managedObjectSourceName,
                                                              java.lang.String qualifier,
                                                              java.lang.String type)

Description copied from interface: OfficeSupplier

Obtains the OfficeManagedObjectSource.

Specified by:

getOfficeManagedObjectSource in interface OfficeSupplier

Parameters:

managedObjectSourceName - Name of the OfficeManagedObjectSource.

qualifier - Qualifier on the object type. May be null to match only on type.

type - Type of object required from the OfficeSupplier.

Returns:

OfficeManagedObjectSource.

getOfficeNode

public OfficeNode getOfficeNode()

Description copied from interface: SupplierNode

Obtains the parent OfficeNode.

Specified by:

getOfficeNode in interface SupplierNode

Returns:

Parent OfficeNode or null if configured at the OfficeFloor level.

getOfficeFloorNode

public OfficeFloorNode getOfficeFloorNode()

Description copied from interface: SupplierNode

Obtains the parent OfficeFloorNode.

Specified by:

getOfficeFloorNode in interface SupplierNode

Returns:

Parent OfficeFloorNode.

loadInitialSupplierType

public InitialSupplierType loadInitialSupplierType(boolean isLoadingType)

Description copied from interface: SupplierNode

Loads the InitialSupplierType.

Specified by:

loadInitialSupplierType in interface SupplierNode

Parameters:

isLoadingType - Indicates if using to load type.

Returns:

InitialSupplierType.

loadSupplierType

public SupplierType loadSupplierType(CompileContext compileContext,
                                     boolean isLoadingType,
                                     AvailableType[] availableTypes)

Description copied from interface: SupplierNode

Loads the SupplierType.

Specified by:

loadSupplierType in interface SupplierNode

Parameters:

compileContext - CompileContext.

isLoadingType - Indicates if using to load type.

availableTypes - AvailableType instances.

Returns:

SupplierType.

registerAsPossibleMBean

public void registerAsPossibleMBean(CompileContext compileContext)

Description copied from interface: SupplierNode

Registers as a possible MBean.

Specified by:

registerAsPossibleMBean in interface SupplierNode

Parameters:

compileContext - CompileContext.

loadAutoWireObjects

public void loadAutoWireObjects(AutoWirer<LinkObjectNode> autoWirer,
                                ManagedObjectSourceVisitor managedObjectSourceVisitor,
                                CompileContext compileContext)

Description copied from interface: SupplierNode

Loads the SuppliedManagedObjectSourceNode instances as ManagedObjectNode instances to the AutoWirer.

Specified by:

loadAutoWireObjects in interface SupplierNode

Parameters:

autoWirer - AutoWirer.

managedObjectSourceVisitor - ManagedObjectSourceVisitor.

compileContext - CompileContext.

loadAutoWireExtensions

public void loadAutoWireExtensions(AutoWirer<ManagedObjectExtensionNode> autoWirer,
                                   ManagedObjectSourceVisitor managedObjectSourceVisitor,
                                   CompileContext compileContext)

Description copied from interface: SupplierNode

Loads the SuppliedManagedObjectSourceNode instances as ManagedObjectExtensionNode instances to the AutoWirer.

Specified by:

loadAutoWireExtensions in interface SupplierNode

Parameters:

autoWirer - AutoWirer.

managedObjectSourceVisitor - ManagedObjectSourceVisitor.

compileContext - CompileContext.

sourceSupplier

public boolean sourceSupplier(CompileContext compileContext)

Description copied from interface: SupplierNode

Sources the SupplierThreadLocal instances.

Specified by:

sourceSupplier in interface SupplierNode

Parameters:

compileContext - CompileContext.

Returns:

true if successfully sourced the SupplierSource. false if failed to source, with issues reported to the CompilerIssues.

sourceComplete

public boolean sourceComplete(CompileContext compileContext)

Description copied from interface: SupplierNode

Flags sourcing functionality complete.

Specified by:

sourceComplete in interface SupplierNode

Parameters:

compileContext - CompileContext.

Returns:

true if successfully handle completing sourcing. false if failed to source, with issues reported to the CompilerIssues.

ensureNoThreadLocals

public boolean ensureNoThreadLocals(CompileContext compileContext)

Description copied from interface: SupplierNode

Ensures there are no SupplierThreadLocalNode and ThreadSynchroniserFactory instances.

SupplierThreadLocal and ThreadSynchroniserFactory instances are only applicable within the Office (application). If SupplierSource is used at the OfficeFloor, then it can only supply ManagedObjectSource instances and not depend on SupplierThreadLocal nor ThreadSynchroniserFactory instances.

If SupplierThreadLocal or ThreadSynchroniserFactory instances then they are raised via CompilerIssues.

Specified by:

ensureNoThreadLocals in interface SupplierNode

Parameters:

compileContext - CompileContext.

Returns:

true if no SupplierThreadLocal nor ThreadSynchroniserFactory instances.

autoWireObjects

public void autoWireObjects(AutoWirer<LinkObjectNode> autoWirer,
                            OfficeNode office,
                            CompileContext compileContext)

Description copied from interface: SupplierNode

Auto-wires the SupplierThreadLocalNode instances that are unlinked.

Specified by:

autoWireObjects in interface SupplierNode

Parameters:

autoWirer - AutoWirer.

office - OfficeNode requiring the auto-wiring.

compileContext - CompileContext.

buildSupplier

public void buildSupplier(OfficeBuilder officeBuilder,
                          CompileContext compileContext)

Description copied from interface: SupplierNode

Builds the SupplierThreadLocal instances for the SupplierSource.

Specified by:

buildSupplier in interface SupplierNode

Parameters:

officeBuilder - OfficeBuilder to build the required thread handling.

compileContext - CompileContext.

getInternalSuppliers

public InternalSupplier[] getInternalSuppliers()

Description copied from interface: SupplierNode

Obtains the InternalSupplier instances.

Specified by:

getInternalSuppliers in interface SupplierNode

Returns:

InternalSupplier instances.