Package net.officefloor.compile.internal.structure

Interface SupplierNode

All Superinterfaces:

Node, OfficeFloorSupplier, OfficeSupplier, PropertyConfigurable

All Known Implementing Classes:

SupplierNodeImpl

public interface SupplierNode
extends Node, OfficeFloorSupplier, OfficeSupplier

Supplier Node.

Author:

Daniel Sagenschneider

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE	Node type.

Method Summary

Modifier and Type	Method	Description
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.
InternalSupplier[]	getInternalSuppliers()	Obtains the InternalSupplier instances.
OfficeFloorNode	getOfficeFloorNode()	Obtains the parent OfficeFloorNode.
OfficeNode	getOfficeNode()	Obtains the parent OfficeNode.
void	initialise(String supplierSourceClassName, SupplierSource supplierSource)	Initialises the SupplierNode.
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 interface net.officefloor.compile.internal.structure.Node

getChildNodes, getLocation, getNodeName, getNodeType, getParentNode, getQualifiedName, getQualifiedName, isInitialised

Methods inherited from interface net.officefloor.compile.spi.officefloor.OfficeFloorSupplier

getOfficeFloorManagedObjectSource, getOfficeFloorSupplierName, getOfficeFloorSupplierThreadLocal

Methods inherited from interface net.officefloor.compile.spi.office.OfficeSupplier

getOfficeManagedObjectSource, getOfficeSupplierName, getOfficeSupplierThreadLocal

Methods inherited from interface net.officefloor.compile.properties.PropertyConfigurable

addProperty

Field Details

TYPE

static final String TYPE

Node type.

See Also:

• Constant Field Values

Method Details

initialise

void initialise(String supplierSourceClassName,
 SupplierSource supplierSource)

Initialises the SupplierNode.

Parameters:

supplierSourceClassName - Class name of the SupplierSource.

supplierSource - Optional instantiated SupplierSource. May be null.

getOfficeNode

OfficeNode getOfficeNode()

Obtains the parent OfficeNode.

Returns:

Parent OfficeNode or null if configured at the OfficeFloor level.

getOfficeFloorNode

OfficeFloorNode getOfficeFloorNode()

Obtains the parent OfficeFloorNode.

Returns:

Parent OfficeFloorNode.

loadInitialSupplierType

InitialSupplierType loadInitialSupplierType(boolean isLoadingType)

Loads the InitialSupplierType.

Parameters:

isLoadingType - Indicates if using to load type.

Returns:

InitialSupplierType.

loadSupplierType

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

Loads the SupplierType.

Parameters:

compileContext - CompileContext.

isLoadingType - Indicates if using to load type.

availableTypes - AvailableType instances.

Returns:

SupplierType.

registerAsPossibleMBean

void registerAsPossibleMBean(CompileContext compileContext)

Registers as a possible MBean.

Parameters:

compileContext - CompileContext.

sourceSupplier

boolean sourceSupplier(CompileContext compileContext)

Sources the SupplierThreadLocal instances.

Parameters:

compileContext - CompileContext.

Returns:

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

sourceComplete

boolean sourceComplete(CompileContext compileContext)

Flags sourcing functionality complete.

Parameters:

compileContext - CompileContext.

Returns:

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

ensureNoThreadLocals

boolean ensureNoThreadLocals(CompileContext compileContext)

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.

Parameters:

compileContext - CompileContext.

Returns:

true if no SupplierThreadLocal nor ThreadSynchroniserFactory instances.

loadAutoWireObjects

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

Loads the SuppliedManagedObjectSourceNode instances as ManagedObjectNode instances to the AutoWirer.

Parameters:

autoWirer - AutoWirer.

managedObjectSourceVisitor - ManagedObjectSourceVisitor.

compileContext - CompileContext.

loadAutoWireExtensions

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

Loads the SuppliedManagedObjectSourceNode instances as ManagedObjectExtensionNode instances to the AutoWirer.

Parameters:

autoWirer - AutoWirer.

managedObjectSourceVisitor - ManagedObjectSourceVisitor.

compileContext - CompileContext.

autoWireObjects

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

Auto-wires the SupplierThreadLocalNode instances that are unlinked.

Parameters:

autoWirer - AutoWirer.

office - OfficeNode requiring the auto-wiring.

compileContext - CompileContext.

buildSupplier

void buildSupplier(OfficeBuilder officeBuilder,
 CompileContext compileContext)

Builds the SupplierThreadLocal instances for the SupplierSource.

Parameters:

officeBuilder - OfficeBuilder to build the required thread handling.

compileContext - CompileContext.

getInternalSuppliers

InternalSupplier[] getInternalSuppliers()

Obtains the InternalSupplier instances.

Returns:

InternalSupplier instances.