Package net.officefloor.compile.impl.util

Class LinkUtil

java.lang.Object

net.officefloor.compile.impl.util.LinkUtil

public class LinkUtil
extends Object

Utility class to work with links.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
static <T extends LinkFlowNode> T	findFurtherestTarget(LinkFlowNode link, Class<T> targetType, CompilerIssues issues)	Finds the furtherest target link by the specified type.
static <T extends LinkFlowNode> T	findTarget(LinkFlowNode link, Class<T> targetType, CompilerIssues issues)	Finds the target link by the specified type.
static <T extends LinkObjectNode> T	findTarget(LinkObjectNode link, Class<T> targetType, CompilerIssues issues)	Finds the target link by the specified type.
static <T extends Node> T	findTarget(LinkPoolNode link, Class<T> targetType, CompilerIssues issues)	Finds the target by the specified type.
static <T extends Node> T	findTarget(LinkTeamNode link, Class<T> targetType, CompilerIssues issues)	Finds the target link by the specified type.
static <T extends Node> T[]	findTargets(LinkStartAfterNode link, Class<T> targetType, CompilerIssues issues)	Finds the targets by the specified type.
static <T extends Node> T[]	findTargets(LinkStartBeforeNode link, Class<T> targetType, CompilerIssues issues)	Finds the targets by the specified type.
static boolean	linkAutoWireObjectNode(LinkObjectNode node, LinkObjectNode linkNode, OfficeNode office, AutoWirer<LinkObjectNode> autoWirer, CompileContext compileContext, CompilerIssues issues, Consumer<LinkObjectNode> loader)	Links the AutoWire LinkObjectNode.
static boolean	linkAutoWireStartAfter(Object managedObjectSource, String managedObjectType, CompilerIssues issues, Node node)	Links the ManagedObjectSourceNode to start after ManagedObject object type.
static boolean	linkAutoWireStartBefore(Object managedObjectSource, String managedObjectType, CompilerIssues issues, Node node)	Links the ManagedObjectSourceNode to start before ManagedObject object type.
static boolean	linkExecutionStrategy(Object linkSource, Object linkTarget, CompilerIssues issues, Node node)	Ensure both inputs are a LinkExecutionStrategyNode and if so links them.
static boolean	linkExecutionStrategyNode(LinkExecutionStrategyNode node, LinkExecutionStrategyNode linkNode, CompilerIssues issues, Consumer<LinkExecutionStrategyNode> loader)	Links the LinkExecutionStrategyNode.
static boolean	linkFlow(Object linkSource, Object linkTarget, CompilerIssues issues, Node node)	Ensures both inputs are a LinkFlowNode and if so links them.
static boolean	linkFlowNode(LinkFlowNode node, LinkFlowNode linkNode, CompilerIssues issues, Consumer<LinkFlowNode> loader)	Links the LinkFlowNode.
static boolean	linkManagedObjectSourceInput(Object managedObjectSource, Object inputManagedObject, CompilerIssues issues, Node node)	Links the ManagedObjectSourceNode to the InputManagedObjectNode.
static boolean	linkObject(Object linkSource, Object linkTarget, CompilerIssues issues, Node node)	Ensures both inputs are a LinkObjectNode and if so links them.
static boolean	linkObjectNode(LinkObjectNode node, LinkObjectNode linkNode, CompilerIssues issues, Consumer<LinkObjectNode> loader)	Links the LinkObjectNode.
static boolean	linkOffice(Object linkSource, Object linkTarget, CompilerIssues issues, Node node)	Ensures both inputs are a LinkOfficeNode and if so links them.
static boolean	linkOfficeNode(LinkOfficeNode node, LinkOfficeNode linkNode, CompilerIssues issues, Consumer<LinkOfficeNode> loader)	Links the LinkOfficeNode.
static boolean	linkPool(Object linkSource, Object linkTarget, CompilerIssues issues, Node node)	Ensures both inputs are a LinkPoolNode and if so links them.
static boolean	linkPoolNode(LinkPoolNode node, LinkPoolNode linkNode, CompilerIssues issues, Consumer<LinkPoolNode> loader)	Links the LinkPoolNode.
static boolean	linkStartAfter(Object startLater, Object startEarlier, CompilerIssues issues, Node node)	Links the ManagedObjectSourceNode to start after another ManagedObjectSourceNode.
static boolean	linkStartBefore(Object startEarlier, Object startLater, CompilerIssues issues, Node node)	Links the ManagedObjectSourceNode to start before another ManagedObjectSourceNode.
static boolean	linkTeam(Object linkSource, Object linkTarget, CompilerIssues issues, Node node)	Ensures both inputs are a LinkTeamNode and if so links them.
static boolean	linkTeamNode(LinkTeamNode node, LinkTeamNode linkNode, CompilerIssues issues, Consumer<LinkTeamNode> loader)	Links the LinkObjectNode.
static void	loadAllObjectAutoWires(LinkObjectNode node, Set<AutoWire> allAutoWires, CompileContext compileContext, CompilerIssues issues)	Loads the AutoWire instances for the LinkObjectNode along with its dependency AutoWire instances and subsequent (transitive) dependency AutoWire instances.
static <T extends LinkObjectNode> T	retrieveFurtherestTarget(LinkObjectNode link, Class<T> targetType, CompilerIssues issues)	Finds the furtherest target link by the specified type.
static <T extends Node> T	retrieveTarget(LinkExecutionStrategyNode link, Class<T> targetType, CompilerIssues issues)	Retrieves the target link by the specified type.
static <T extends LinkFlowNode> T	retrieveTarget(LinkFlowNode link, Class<T> targetType, CompilerIssues issues)	Retrieves the target link by the specified type.
static <T extends LinkObjectNode> T	retrieveTarget(LinkObjectNode link, Class<T> targetType, CompilerIssues issues)	Retrieves the target link by the specified type.
static <T extends Node> T	retrieveTarget(LinkOfficeNode link, Class<T> targetType, CompilerIssues issues)	Retrieves the target link by the specified type.

Methods inherited from class java.lang.Object

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

Method Details

linkFlow

public static boolean linkFlow(Object linkSource,
 Object linkTarget,
 CompilerIssues issues,
 Node node)

Ensures both inputs are a LinkFlowNode and if so links them.

Parameters:

linkSource - Source LinkFlowNode.

linkTarget - Target LinkFlowNode.

issues - CompilerIssues.

node - Node wishing to link the Flow.

Returns:

true if linked.

linkObject

public static boolean linkObject(Object linkSource,
 Object linkTarget,
 CompilerIssues issues,
 Node node)

Ensures both inputs are a LinkObjectNode and if so links them.

Parameters:

linkSource - Source LinkObjectNode.

linkTarget - Target LinkObjectNode.

issues - CompilerIssues.

node - Node wishing to link the Flow.

Returns:

true if linked.

linkTeam

public static boolean linkTeam(Object linkSource,
 Object linkTarget,
 CompilerIssues issues,
 Node node)

Ensures both inputs are a LinkTeamNode and if so links them.

Parameters:

linkSource - Source LinkTeamNode.

linkTarget - Target LinkTeamNode.

issues - CompilerIssues.

node - Node wishing to link the Flow.

Returns:

true if linked.

linkExecutionStrategy

public static boolean linkExecutionStrategy(Object linkSource,
 Object linkTarget,
 CompilerIssues issues,
 Node node)

Ensure both inputs are a LinkExecutionStrategyNode and if so links them.

Parameters:

linkSource - Source LinkExecutionStrategyNode.

linkTarget - Target LinkExecutionStrategyNode.

issues - CompilerIssues.

node - Node wishing to link the ExecutionStrategy.

Returns:

true if linked.

linkOffice

public static boolean linkOffice(Object linkSource,
 Object linkTarget,
 CompilerIssues issues,
 Node node)

Ensures both inputs are a LinkOfficeNode and if so links them.

Parameters:

linkSource - Source LinkOfficeNode.

linkTarget - Target LinkOfficeNode.

issues - CompilerIssues.

node - Node wishing to link the Flow.

Returns:

true if linked.

linkPool

public static boolean linkPool(Object linkSource,
 Object linkTarget,
 CompilerIssues issues,
 Node node)

Ensures both inputs are a LinkPoolNode and if so links them.

Parameters:

linkSource - Source LinkPoolNode.

linkTarget - Target LinkPoolNode.

issues - CompilerIssues.

node - Node wishing to link the ManagedObjectPool.

Returns:

true if linked.

linkManagedObjectSourceInput

public static boolean linkManagedObjectSourceInput(Object managedObjectSource,
 Object inputManagedObject,
 CompilerIssues issues,
 Node node)

Links the ManagedObjectSourceNode to the InputManagedObjectNode.

Parameters:

managedObjectSource - ManagedObjectSourceNode.

inputManagedObject - InputManagedObjectNode.

issues - CompilerIssues.

node - Node wishing to link the Flow.

Returns:

true if linked.

linkStartBefore

public static boolean linkStartBefore(Object startEarlier,
 Object startLater,
 CompilerIssues issues,
 Node node)

Links the ManagedObjectSourceNode to start before another ManagedObjectSourceNode.

Parameters:

startEarlier - ManagedObjectSourceNode to start earlier.

startLater - ManagedObjectSourceNode to start later.

issues - CompilerIssues.

node - Node wishing to link the start before.

Returns:

true if linked.

linkAutoWireStartBefore

public static boolean linkAutoWireStartBefore(Object managedObjectSource,
 String managedObjectType,
 CompilerIssues issues,
 Node node)

Links the ManagedObjectSourceNode to start before ManagedObject object type.

Parameters:

managedObjectSource - ManagedObjectSourceNode to start earlier.

managedObjectType - ManagedObject object type to start later.

issues - CompilerIssues.

node - Node wishing to link the start before.

Returns:

true if linked.

linkStartAfter

public static boolean linkStartAfter(Object startLater,
 Object startEarlier,
 CompilerIssues issues,
 Node node)

Links the ManagedObjectSourceNode to start after another ManagedObjectSourceNode.

Parameters:

startLater - ManagedObjectSourceNode to start later.

startEarlier - ManagedObjectSourceNode to start earlier.

issues - CompilerIssues.

node - Node wishing to link the start before.

Returns:

true if linked.

linkAutoWireStartAfter

public static boolean linkAutoWireStartAfter(Object managedObjectSource,
 String managedObjectType,
 CompilerIssues issues,
 Node node)

Links the ManagedObjectSourceNode to start after ManagedObject object type.

Parameters:

managedObjectSource - ManagedObjectSourceNode to start later.

managedObjectType - ManagedObject object type to start earlier.

issues - CompilerIssues.

node - Node wishing to link the start before.

Returns:

true if linked.

findFurtherestTarget

public static <T extends LinkFlowNode> T findFurtherestTarget(LinkFlowNode link,
 Class<T> targetType,
 CompilerIssues issues)

Finds the furtherest target link by the specified type.

Type Parameters:

T - Target type.

Parameters:

link - Starting LinkFlowNode.

targetType - Target LinkFlowNode type to find.

issues - CompilerIssues.

Returns:

Furtherest target LinkFlowNode or null if no targets found.

retrieveFurtherestTarget

public static <T extends LinkObjectNode> T retrieveFurtherestTarget(LinkObjectNode link,
 Class<T> targetType,
 CompilerIssues issues)

Finds the furtherest target link by the specified type.

Type Parameters:

T - Target type.

Parameters:

link - Starting LinkObjectNode.

targetType - Target LinkObjectNode type to find.

issues - CompilerIssues.

Returns:

Furthurest target LinkObjectNode or null if no targets found.

findTarget

public static <T extends LinkFlowNode> T findTarget(LinkFlowNode link,
 Class<T> targetType,
 CompilerIssues issues)

Finds the target link by the specified type.

Type Parameters:

T - Target type.

Parameters:

link - Starting LinkFlowNode.

targetType - Target LinkFlowNode type to find.

issues - CompilerIssues.

Returns:

Target LinkFlowNode or null if target not found.

retrieveTarget

public static <T extends LinkFlowNode> T retrieveTarget(LinkFlowNode link,
 Class<T> targetType,
 CompilerIssues issues)

Retrieves the target link by the specified type.

Type Parameters:

T - Target type.

Parameters:

link - Starting LinkFlowNode.

targetType - Target LinkFlowNode type to retrieve.

issues - CompilerIssues.

Returns:

Target LinkFlowNode or null if issue obtaining which is reported to the CompilerIssues.

retrieveTarget

public static <T extends LinkObjectNode> T retrieveTarget(LinkObjectNode link,
 Class<T> targetType,
 CompilerIssues issues)

Retrieves the target link by the specified type.

Type Parameters:

T - Target type.

Parameters:

link - Starting LinkObjectNode.

targetType - Target LinkObjectNode type to retrieve.

issues - CompilerIssues.

Returns:

Target LinkObjectNode or null if issue obtaining which is reported to the CompilerIssues.

findTarget

public static <T extends LinkObjectNode> T findTarget(LinkObjectNode link,
 Class<T> targetType,
 CompilerIssues issues)

Finds the target link by the specified type.

Type Parameters:

T - Target type.

Parameters:

link - Starting LinkObjectNode.

targetType - Target LinkObjectNode type to retrieve.

issues - CompilerIssues.

Returns:

Target LinkObjectNode or null if not found.

findTarget

public static <T extends Node> T findTarget(LinkTeamNode link,
 Class<T> targetType,
 CompilerIssues issues)

Finds the target link by the specified type.

Type Parameters:

T - Target type.

Parameters:

link - Starting LinkTeamNode.

targetType - Target LinkTeamNode type to retrieve.

issues - CompilerIssues.

Returns:

Target LinkTeamNode or null if not found.

retrieveTarget

public static <T extends Node> T retrieveTarget(LinkExecutionStrategyNode link,
 Class<T> targetType,
 CompilerIssues issues)

Retrieves the target link by the specified type.

Type Parameters:

T - Target type.

Parameters:

link - Starting LinkExecutionStrategyNode.

targetType - Target LinkExecutionStrategyNode type to retrieve.

issues - CompilerIssues.

Returns:

Target LinkExecutionStrategyNode or null if issue obtaining which is reported to the CompilerIssues.

retrieveTarget

public static <T extends Node> T retrieveTarget(LinkOfficeNode link,
 Class<T> targetType,
 CompilerIssues issues)

Retrieves the target link by the specified type.

Type Parameters:

T - Target type.

Parameters:

link - Starting LinkOfficeNode.

targetType - Target LinkOfficeNode type to retrieve.

issues - CompilerIssues.

Returns:

Target LinkOfficeNode or null if issue obtaining which is reported to the CompilerIssues.

findTarget

public static <T extends Node> T findTarget(LinkPoolNode link,
 Class<T> targetType,
 CompilerIssues issues)

Finds the target by the specified type.

Type Parameters:

T - Target type.

Parameters:

link - Starting LinkPoolNode.

targetType - Target LinkPoolNode type to retrieve.

issues - CompilerIssues.

Returns:

Target LinkPoolNode or null if target not found.

findTargets

public static <T extends Node> T[] findTargets(LinkStartBeforeNode link,
 Class<T> targetType,
 CompilerIssues issues)

Finds the targets by the specified type.

Type Parameters:

T - Target type.

Parameters:

link - Starting LinkStartBeforeNode.

targetType - Target LinkStartBeforeNode type to retrieve.

issues - CompilerIssues.

Returns:

Target LinkStartBeforeNode targets found.

findTargets

public static <T extends Node> T[] findTargets(LinkStartAfterNode link,
 Class<T> targetType,
 CompilerIssues issues)

Finds the targets by the specified type.

Type Parameters:

T - Target type.

Parameters:

link - Starting LinkStartAfterNode.

targetType - Target LinkStartAfterNode type to retrieve.

issues - CompilerIssues.

Returns:

Target LinkStartAfterNode targets found.

linkFlowNode

public static boolean linkFlowNode(LinkFlowNode node,
 LinkFlowNode linkNode,
 CompilerIssues issues,
 Consumer<LinkFlowNode> loader)

Links the LinkFlowNode.

Parameters:

node - LinkFlowNode to have the link loaded.

linkNode - Link LinkFlowNode to load.

issues - CompilerIssues.

loader - Consumer to load the link onto the LinkFlowNode.

Returns:

true if successful, or false with issue reported to the CompilerIssues.

linkObjectNode

public static boolean linkObjectNode(LinkObjectNode node,
 LinkObjectNode linkNode,
 CompilerIssues issues,
 Consumer<LinkObjectNode> loader)

Links the LinkObjectNode.

Parameters:

node - LinkObjectNode to have the link loaded.

linkNode - Link LinkObjectNode to load.

issues - CompilerIssues.

loader - Consumer to load the link onto the LinkObjectNode.

Returns:

true if successful, or false with issue reported to the CompilerIssues.

linkAutoWireObjectNode

public static boolean linkAutoWireObjectNode(LinkObjectNode node,
 LinkObjectNode linkNode,
 OfficeNode office,
 AutoWirer<LinkObjectNode> autoWirer,
 CompileContext compileContext,
 CompilerIssues issues,
 Consumer<LinkObjectNode> loader)

Links the AutoWire LinkObjectNode.

Parameters:

node - LinkObjectNode to have the link loaded.

linkNode - Link LinkObjectNode to load.

office - OfficeNode.

autoWirer - AutoWirer to enable dependencies to be auto-wired.

compileContext - CompileContext.

issues - CompilerIssues.

loader - Consumer to load the link onto the LinkObjectNode.

Returns:

true if successful, or false with issue reported to the CompilerIssues.

loadAllObjectAutoWires

public static void loadAllObjectAutoWires(LinkObjectNode node,
 Set<AutoWire> allAutoWires,
 CompileContext compileContext,
 CompilerIssues issues)

Loads the AutoWire instances for the LinkObjectNode along with its dependency AutoWire instances and subsequent (transitive) dependency AutoWire instances.

Parameters:

node - LinkObjectNode to load transitive dependency AutoWire instances.

allAutoWires - Set to be loaded with all the AutoWire instances.

compileContext - CompileContext

issues - CompilerIssues.

linkTeamNode

public static boolean linkTeamNode(LinkTeamNode node,
 LinkTeamNode linkNode,
 CompilerIssues issues,
 Consumer<LinkTeamNode> loader)

Links the LinkObjectNode.

Parameters:

node - LinkTeamNode to have the link loaded.

linkNode - Link LinkTeamNode to load.

issues - CompilerIssues.

loader - Consumer to load the link onto the LinkTeamNode.

Returns:

true if successful, or false with issue reported to the CompilerIssues.

linkExecutionStrategyNode

public static boolean linkExecutionStrategyNode(LinkExecutionStrategyNode node,
 LinkExecutionStrategyNode linkNode,
 CompilerIssues issues,
 Consumer<LinkExecutionStrategyNode> loader)

Links the LinkExecutionStrategyNode.

Parameters:

node - LinkExecutionStrategyNode to have the link loaded.

linkNode - LinkExecutionStrategyNode to load.

issues - CompilerIssues.

loader - Consumer to load the link onto the LinkExecutionStrategyNode.

Returns:

true if successful, or false with issue reported to the CompilerIssues.

linkOfficeNode

public static boolean linkOfficeNode(LinkOfficeNode node,
 LinkOfficeNode linkNode,
 CompilerIssues issues,
 Consumer<LinkOfficeNode> loader)

Links the LinkOfficeNode.

Parameters:

node - LinkOfficeNode to have the link loaded.

linkNode - Link LinkOfficeNode to load.

issues - CompilerIssues.

loader - Consumer to load the link on the LinkOfficeNode.

Returns:

true if successful, or false with issue reported to the CompilerIssues.

linkPoolNode

public static boolean linkPoolNode(LinkPoolNode node,
 LinkPoolNode linkNode,
 CompilerIssues issues,
 Consumer<LinkPoolNode> loader)

Links the LinkPoolNode.

Parameters:

node - LinkPoolNode to have the link loaded.

linkNode - Link LinkPoolNode to load.

issues - CompilerIssues.

loader - Consumer to load the link on the LinkPoolNode.

Returns:

true if successful, or false with issue reported to the CompilerIssues.