Package net.officefloor.frame.api.executive

Class TeamSourceContextWrapper

java.lang.Object

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

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

net.officefloor.frame.api.executive.TeamSourceContextWrapper

All Implemented Interfaces:

ServiceContext, SourceContext, SourceProperties, TeamSourceContext

public class TeamSourceContextWrapper
extends SourceContextImpl
implements TeamSourceContext

Wrapper of TeamSourceContext to enable customising the Team.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TeamSourceContextWrapper.WorkerEnvironment	Provides a wrapper around the Runnable from the Executive for a Thread.

Constructor Summary

Constructors

Constructor	Description
TeamSourceContextWrapper(ExecutiveContext context, Function<Integer,Integer> teamSizeCalculator, String teamNameSuffix, TeamSourceContextWrapper.WorkerEnvironment workerEnvironment)	Instantiate.

Method Summary

Modifier and Type	Method	Description
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.
ThreadFactory	getThreadFactory()	Obtains the ThreadFactory for the Team.

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 Details

TeamSourceContextWrapper

public TeamSourceContextWrapper(ExecutiveContext context,
 Function<Integer,Integer> teamSizeCalculator,
 String teamNameSuffix,
 TeamSourceContextWrapper.WorkerEnvironment workerEnvironment)

Instantiate.

Parameters:

context - ExecutiveContext.

teamSizeCalculator - Calculates the Team size from the configured Team size.

teamNameSuffix - Optional suffix for the Team name. May be null for no suffix.

workerEnvironment - TeamSourceContextWrapper.WorkerEnvironment. May be null.

Method Details

getTeamName

public 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 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.