Package net.officefloor.frame.impl.construct.managedobject

Class DependencyMappingBuilderImpl<O extends java.lang.Enum<O>>

java.lang.Object

net.officefloor.frame.impl.construct.managedobject.DependencyMappingBuilderImpl<O>

All Implemented Interfaces:

DependencyMappingBuilder, ThreadDependencyMappingBuilder, InputManagedObjectConfiguration<O>, ManagedObjectConfiguration<O>

public class DependencyMappingBuilderImpl<O extends java.lang.Enum<O>>
extends java.lang.Object
implements DependencyMappingBuilder, ThreadDependencyMappingBuilder, ManagedObjectConfiguration<O>, InputManagedObjectConfiguration<O>

DependencyMappingBuilder implementation.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor	Description
DependencyMappingBuilderImpl(java.lang.String boundManagedObjectName)	Initiate as an InputManagedObjectConfiguration.
DependencyMappingBuilderImpl(java.lang.String boundManagedObjectName, java.lang.String officeManagedObjectName)	Initiate as a ManagedObjectConfiguration.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getBoundManagedObjectName()	Obtains name of the ManagedObject bound to either ProcessState or ThreadState.
ManagedObjectDependencyConfiguration<O>[]	getDependencyConfiguration()	Obtains the listing of ManagedObjectDependencyConfiguration instances.
ManagedObjectGovernanceConfiguration[]	getGovernanceConfiguration()	Obtains the listing of ManagedObjectGovernanceConfiguration instances.
java.lang.String	getOfficeManagedObjectName()	Obtains the name of the ManagedObject registered within the Office.
<T> OptionalThreadLocal<T>	getOptionalThreadLocal()	Obtains the OptionalThreadLocal for the ManagedObject.
AdministrationConfiguration<?,?,?>[]	getPreLoadAdministration()	Obtains the listing of the Administration to be done before the ManagedObject is loaded.
ThreadLocalConfiguration	getThreadLocalConfiguration()	Obtains the ThreadLocalConfiguration.
void	mapDependency(int index, java.lang.String scopeManagedObjectName)	Specifies the ManagedObject for the index identifying the dependency.
<d extends java.lang.Enum<d>> void	mapDependency(d key, java.lang.String scopeManagedObjectName)	Specifies the ManagedObject for the dependency key.
void	mapGovernance(java.lang.String governanceName)	Specifies the Governance for the ManagedObject.
<E,f extends java.lang.Enum<f>,G extends java.lang.Enum<G>> AdministrationBuilder<f,G>	preLoadAdminister(java.lang.String administrationName, java.lang.Class<E> extension, AdministrationFactory<E,f,G> administrationFactory)	Adds Administration to be undertaken before this ManagedObject is loaded.

Methods inherited from class java.lang.Object

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

Constructor Detail

DependencyMappingBuilderImpl

public DependencyMappingBuilderImpl(java.lang.String boundManagedObjectName,
                                    java.lang.String officeManagedObjectName)

Initiate as a ManagedObjectConfiguration.

Parameters:

boundManagedObjectName - Name of the ManagedObject is being bound.

officeManagedObjectName - Name of the ManagedObject within the Office.

DependencyMappingBuilderImpl

public DependencyMappingBuilderImpl(java.lang.String boundManagedObjectName)

Initiate as an InputManagedObjectConfiguration.

Parameters:

boundManagedObjectName - Name of the ManagedObject is being bound.

Method Detail

mapDependency

public <d extends java.lang.Enum<d>> void mapDependency(d key,
                                                        java.lang.String scopeManagedObjectName)

Description copied from interface: DependencyMappingBuilder

Specifies the ManagedObject for the dependency key.

Specified by:

mapDependency in interface DependencyMappingBuilder

Type Parameters:

d - Dependency key type.

Parameters:

key - Key of the dependency.

scopeManagedObjectName - Name of the ManagedObject within the scope that this DependencyMappingBuilder was created.

mapDependency

public void mapDependency(int index,
                          java.lang.String scopeManagedObjectName)

Description copied from interface: DependencyMappingBuilder

Specifies the ManagedObject for the index identifying the dependency.

Specified by:

mapDependency in interface DependencyMappingBuilder

Parameters:

index - Index identifying the dependency.

scopeManagedObjectName - Name of the ManagedObject within the scope that this DependencyMappingBuilder was created.

mapGovernance

public void mapGovernance(java.lang.String governanceName)

Description copied from interface: DependencyMappingBuilder

Specifies the Governance for the ManagedObject.

Specified by:

mapGovernance in interface DependencyMappingBuilder

Parameters:

governanceName - Name of the Governance within the Office.

preLoadAdminister

public <E,f extends java.lang.Enum<f>,G extends java.lang.Enum<G>> AdministrationBuilder<f,G> preLoadAdminister(java.lang.String administrationName,
                                                                                                                                  java.lang.Class<E> extension,
                                                                                                                                  AdministrationFactory<E,f,G> administrationFactory)

Description copied from interface: DependencyMappingBuilder

Adds Administration to be undertaken before this ManagedObject is loaded.

Specified by:

preLoadAdminister in interface DependencyMappingBuilder

Type Parameters:

E - Extension type.

f - Flow key type.

G - Governance key type.

Parameters:

administrationName - Name of the Administration.

extension - Extension type for Administration.

administrationFactory - AdministrationFactory.

Returns:

AdministrationBuilder to build the Administration.

getOptionalThreadLocal

public <T> OptionalThreadLocal<T> getOptionalThreadLocal()

Description copied from interface: ThreadDependencyMappingBuilder

Obtains the OptionalThreadLocal for the ManagedObject.

Specified by:

getOptionalThreadLocal in interface ThreadDependencyMappingBuilder

Type Parameters:

T - Type of object.

Returns:

OptionalThreadLocal for the ManagedObject.

getBoundManagedObjectName

public java.lang.String getBoundManagedObjectName()

Description copied from interface: ManagedObjectConfiguration

Obtains name of the ManagedObject bound to either ProcessState or ThreadState.

Specified by:

getBoundManagedObjectName in interface InputManagedObjectConfiguration<O extends java.lang.Enum<O>>

Specified by:

getBoundManagedObjectName in interface ManagedObjectConfiguration<O extends java.lang.Enum<O>>

Returns:

Name of the ManagedObject bound to either ProcessState or ThreadState.

getOfficeManagedObjectName

public java.lang.String getOfficeManagedObjectName()

Description copied from interface: ManagedObjectConfiguration

Obtains the name of the ManagedObject registered within the Office.

Specified by:

getOfficeManagedObjectName in interface ManagedObjectConfiguration<O extends java.lang.Enum<O>>

Returns:

Name of the ManagedObject registered within the Office.

getDependencyConfiguration

public ManagedObjectDependencyConfiguration<O>[] getDependencyConfiguration()

Description copied from interface: ManagedObjectConfiguration

Obtains the listing of ManagedObjectDependencyConfiguration instances.

Specified by:

getDependencyConfiguration in interface InputManagedObjectConfiguration<O extends java.lang.Enum<O>>

Specified by:

getDependencyConfiguration in interface ManagedObjectConfiguration<O extends java.lang.Enum<O>>

Returns:

ManagedObjectDependencyConfiguration instances.

getGovernanceConfiguration

public ManagedObjectGovernanceConfiguration[] getGovernanceConfiguration()

Description copied from interface: ManagedObjectConfiguration

Obtains the listing of ManagedObjectGovernanceConfiguration instances.

Specified by:

getGovernanceConfiguration in interface InputManagedObjectConfiguration<O extends java.lang.Enum<O>>

Specified by:

getGovernanceConfiguration in interface ManagedObjectConfiguration<O extends java.lang.Enum<O>>

Returns:

ManagedObjectGovernanceConfiguration instances.

getPreLoadAdministration

public AdministrationConfiguration<?,?,?>[] getPreLoadAdministration()

Description copied from interface: ManagedObjectConfiguration

Obtains the listing of the Administration to be done before the ManagedObject is loaded.

Specified by:

getPreLoadAdministration in interface InputManagedObjectConfiguration<O extends java.lang.Enum<O>>

Specified by:

getPreLoadAdministration in interface ManagedObjectConfiguration<O extends java.lang.Enum<O>>

Returns:

Listing of the Administration to be done before the ManagedObject is loaded.

getThreadLocalConfiguration

public ThreadLocalConfiguration getThreadLocalConfiguration()

Description copied from interface: ManagedObjectConfiguration

Obtains the ThreadLocalConfiguration.

Specified by:

getThreadLocalConfiguration in interface InputManagedObjectConfiguration<O extends java.lang.Enum<O>>

Specified by:

getThreadLocalConfiguration in interface ManagedObjectConfiguration<O extends java.lang.Enum<O>>

Returns:

ThreadLocalConfiguration or null if not bound to Thread.