Package net.officefloor.activity.compose.build

Interface DirectoryItemComposerContext

public interface DirectoryItemComposerContext

Context for the DirectoryItemComposer.

Method Summary

Modifier and Type	Method	Description
<I, C extends ComposeConfiguration> I	addComposition(String sectionName, ComposeSource<I,C> source, Class<C> configurationType)	Adds a composition for this directory item.
<C> C	getConfiguration(Class<C> type)	Obtains the configuration for the directory item.
String	getItemName()	Obtains the name of the directory item.

Method Details

getItemName

String getItemName()

Obtains the name of the directory item.

Returns:

Name of the directory item.

getConfiguration

<C> C getConfiguration(Class<C> type)

Obtains the configuration for the directory item.

All directory items may not be compositions, so this enables loading non-composition configuration.

Type Parameters:

C - Type of configuration.

Parameters:

type - Type of configuration.

Returns:

Configuration.

addComposition

<I,
C extends ComposeConfiguration> I addComposition(String sectionName,
 ComposeSource<I,C> source,
 Class<C> configurationType)

Adds a composition for this directory item.

Type Parameters:

I - Item type.

C - Configuration type.

Parameters:

sectionName - Name of the OfficeSection to contain the composition.

source - ComposeSource to source the items requiring composition.

configurationType - Class extending ComposeConfiguration to provide additional configuration for the item being built.

Returns:

Composition item.