Package net.officefloor.frame.impl.construct.team

Class ExecutiveContextImpl

java.lang.Object

net.officefloor.frame.impl.construct.source.SourcePropertiesImpl

net.officefloor.frame.impl.construct.source.SourceContextImpl

net.officefloor.frame.impl.construct.team.ExecutiveContextImpl

All Implemented Interfaces:

ExecutiveContext, ServiceContext, SourceContext, SourceProperties, TeamSourceContext

public class ExecutiveContextImpl
extends SourceContextImpl
implements ExecutiveContext

ExecutiveContext implementation.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor	Description
ExecutiveContextImpl(boolean isLoadingType, java.lang.String teamName, int teamSize, TeamSource teamSource, Executive executive, ThreadFactoryManufacturer threadFactoryManufacturer, SourceProperties properties, SourceContext sourceContext)	Initialise.

Method Summary

Modifier and Type	Method	Description
java.util.concurrent.ThreadFactory	createThreadFactory(java.lang.String teamName)	Creates a ThreadFactory for the Team name.
java.lang.String	getTeamName()	Obtains the name of the Team to be created from the TeamSource.
int	getTeamSize()	Obtains the size of the Team.
int	getTeamSize(int defaultSize)	Allows obtaining the size of the Team, without forcing it to be configured.
TeamSource	getTeamSource()	Obtains the TeamSource to create the Team.
java.util.concurrent.ThreadFactory	getThreadFactory()	Obtains the ThreadFactory for the Team.
boolean	isRequireTeamSize()	Indicates if required Team size.

Methods inherited from class net.officefloor.frame.impl.construct.source.SourceContextImpl

getClassLoader, getClock, getLogger, getName, getOptionalResource, getProfiles, getResource, isLoadingType, loadClass, loadOptionalClass, loadOptionalService, loadOptionalServices, loadService, loadService, loadServices

Methods inherited from class net.officefloor.frame.impl.construct.source.SourcePropertiesImpl

addProperty, getProperties, getProperty, getProperty, getPropertyNames

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.officefloor.frame.api.source.SourceContext

getClassLoader, getClock, getLogger, getName, getOptionalResource, getProfiles, getResource, isLoadingType, loadClass, loadOptionalClass, loadOptionalService, loadOptionalServices, loadService, loadService, loadServices

Methods inherited from interface net.officefloor.frame.api.source.SourceProperties

getProperties, getProperty, getProperty, getPropertyNames

Constructor Detail

ExecutiveContextImpl

public ExecutiveContextImpl(boolean isLoadingType,
                            java.lang.String teamName,
                            int teamSize,
                            TeamSource teamSource,
                            Executive executive,
                            ThreadFactoryManufacturer threadFactoryManufacturer,
                            SourceProperties properties,
                            SourceContext sourceContext)

Initialise.

Parameters:

isLoadingType - Indicates if loading type.

teamName - Name of the Team to be created from the TeamSource.

teamSize - Team size. Value of 0 or below indicates no Team size configured.

teamSource - TeamSource.

executive - Executive.

threadFactoryManufacturer - ThreadFactoryManufacturer.

properties - SourceProperties to initialise the TeamSource.

sourceContext - SourceContext.

Method Detail

isRequireTeamSize

public boolean isRequireTeamSize()

Indicates if required Team size.

Returns:

true if the Team size is required.

getTeamName

public java.lang.String getTeamName()

Description copied from interface: TeamSourceContext

Obtains the name of the Team to be created from the TeamSource.

This enables naming the Thread instances for the Team to be specific to the Team.

Specified by:

getTeamName in interface TeamSourceContext

Returns:

Name of the Team to be created from the TeamSource.

getTeamSize

public int getTeamSize()

Description copied from interface: TeamSourceContext

Obtains the size of the Team.

Typically this is the maximum number of Thread instances for the Team. However, for some Team implementations it may not be used (e.g. PassiveTeamSource).

It is provided to allow the Executive to have some control over Team sizes.

Specified by:

getTeamSize in interface TeamSourceContext

Returns:

Team size.

getTeamSize

public int getTeamSize(int defaultSize)

Description copied from interface: TeamSourceContext

Allows obtaining the size of the Team, without forcing it to be configured.

Specified by:

getTeamSize in interface TeamSourceContext

Parameters:

defaultSize - Default size of the Team, if no size configured.

Returns:

Team size.

getThreadFactory

public java.util.concurrent.ThreadFactory getThreadFactory()

Description copied from interface: TeamSourceContext

Obtains the ThreadFactory for the Team.

It is encouraged for Team implementations to use this in creating Thread instances. This is to enable performance improvements by OfficeFloor, such as ThreadLocal ManagedObjectPool solutions to reduce pool locking overheads.

Specified by:

getThreadFactory in interface TeamSourceContext

Returns:

ThreadFactory for the Team.

getTeamSource

public TeamSource getTeamSource()

Description copied from interface: ExecutiveContext

Obtains the TeamSource to create the Team.

Specified by:

getTeamSource in interface ExecutiveContext

Returns:

TeamSource to create the Team.

createThreadFactory

public java.util.concurrent.ThreadFactory createThreadFactory(java.lang.String teamName)

Description copied from interface: ExecutiveContext

Creates a ThreadFactory for the Team name.

The Executive may decide to create multiple Team instances for the actual Team. This allows identifying which Thread will belong to each Team.

Specified by:

createThreadFactory in interface ExecutiveContext

Parameters:

teamName - Name of the Team.

Returns:

ThreadFactory.