Package net.officefloor.compile.spi.officefloor.source

Interface OfficeFloorSourceContext

All Superinterfaces:

ConfigurationContext, SourceContext, SourceProperties

All Known Subinterfaces:

OfficeFloorExtensionContext

All Known Implementing Classes:

OfficeFloorSourceContextImpl

public interface OfficeFloorSourceContext
extends SourceContext, ConfigurationContext

Context for the OfficeFloorSource.

Author:

Daniel Sagenschneider

Field Summary

Fields inherited from interface net.officefloor.configuration.ConfigurationContext

DEFAULT_TAG_PREFIX, DEFAULT_TAG_SUFFIX, PROPERTY_CONFIGURATION_INPUT_CHARSET, PROPERTY_CONFIGURATION_INPUT_TAG_PREFIX, PROPERTY_CONFIGURATION_INPUT_TAG_SUFFIX, PROPERTY_CONFIGURATION_OUTPUT_CHARSET

Method Summary

Modifier and Type	Method	Description
PropertyList	createPropertyList()	Creates a new PropertyList.
java.lang.String	getOfficeFloorLocation()	Obtains the location of the OfficeFloor.
ManagedObjectType<?>	loadManagedObjectType(java.lang.String managedObjectSourceName, java.lang.String managedObjectSourceClassName, PropertyList properties)	Loads the ManagedObjectType.
ManagedObjectType<?>	loadManagedObjectType(java.lang.String managedObjectSourceName, ManagedObjectSource<?,?> managedObjectSource, PropertyList properties)	Loads the ManagedObjectType.
OfficeType	loadOfficeType(java.lang.String officeName, java.lang.String officeSourceClassName, java.lang.String location, PropertyList properties)	Loads the OfficeType.
OfficeType	loadOfficeType(java.lang.String officeName, OfficeSource officeSource, java.lang.String location, PropertyList properties)	Loads the OfficeType.
InitialSupplierType	loadSupplierType(java.lang.String supplierName, java.lang.String supplierSourceClassName, PropertyList properties)	Loads the InitialSupplierType.
InitialSupplierType	loadSupplierType(java.lang.String supplierName, SupplierSource supplierSource, PropertyList properties)	Loads the InitialSupplierType.

Methods inherited from interface net.officefloor.configuration.ConfigurationContext

getConfigurationItem, getOptionalConfigurationItem

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

Method Detail

getOfficeFloorLocation

java.lang.String getOfficeFloorLocation()

Obtains the location of the OfficeFloor.

How "location" is interpreted is for the OfficeFloorSource.

Returns:

Location of the OfficeFloor.

createPropertyList

PropertyList createPropertyList()

Creates a new PropertyList.

Returns:

New PropertyList.

loadManagedObjectType

ManagedObjectType<?> loadManagedObjectType(java.lang.String managedObjectSourceName,
                                           java.lang.String managedObjectSourceClassName,
                                           PropertyList properties)

Loads the ManagedObjectType.

This is to enable obtaining the type information for the ManagedObject to allow reflective configuration by the OfficeFloorSource.

Parameters:

managedObjectSourceName - Name of the ManagedObjectSource.

managedObjectSourceClassName - Name of the implementing ManagedObjectSource class. May also be an alias.

properties - PropertyList to configure the ManagedObjectSource.

Returns:

ManagedObjectType or null if fails to load the ManagedObjectType.

loadManagedObjectType

ManagedObjectType<?> loadManagedObjectType(java.lang.String managedObjectSourceName,
                                           ManagedObjectSource<?,?> managedObjectSource,
                                           PropertyList properties)

Loads the ManagedObjectType.

This is to enable obtaining the type information for the ManagedObject to allow reflective configuration by the OfficeFloorSource.

Parameters:

managedObjectSourceName - Name of the ManagedObjectSource.

managedObjectSource - ManagedObjectSource instance.

properties - PropertyList to configure the ManagedObjectSource.

Returns:

ManagedObjectType or null if fails to load the ManagedObjectType.

loadSupplierType

InitialSupplierType loadSupplierType(java.lang.String supplierName,
                                     java.lang.String supplierSourceClassName,
                                     PropertyList properties)

Loads the InitialSupplierType.

This is to enable obtaining the type information for the SupplierSource to allow reflective configuration by the OfficeFloorSource.

Parameters:

supplierName - Name of the SupplierSource.

supplierSourceClassName - Name of the implementing SupplierSource class. May also be an alias.

properties - PropertyList to configure the SupplierSource.

Returns:

InitialSupplierType or null if fails to load the InitialSupplierType.

loadSupplierType

InitialSupplierType loadSupplierType(java.lang.String supplierName,
                                     SupplierSource supplierSource,
                                     PropertyList properties)

Loads the InitialSupplierType.

This is to enable obtaining the type information for the SupplierSource to allow reflective configuration by the OfficeFloorSource.

Parameters:

supplierName - Name of the SupplierSource.

supplierSource - SupplierSource.

properties - PropertyList to configure the SupplierSource.

Returns:

InitialSupplierType or null if fails to load the InitialSupplierType.

loadOfficeType

OfficeType loadOfficeType(java.lang.String officeName,
                          java.lang.String officeSourceClassName,
                          java.lang.String location,
                          PropertyList properties)

Loads the OfficeType.

This is to enable obtaining the type information for the Office to allow reflective configuration by the OfficeFloorSource.

Parameters:

officeName - Name of the Office.

officeSourceClassName - Name of the implementing OfficeSource class. May also be an alias.

location - Location of the Office.

properties - PropertyList to configure the OfficeSource.

Returns:

OfficeType or null if fails to load the OfficeType.

loadOfficeType

OfficeType loadOfficeType(java.lang.String officeName,
                          OfficeSource officeSource,
                          java.lang.String location,
                          PropertyList properties)

Loads the OfficeType.

This is to enable obtaining the type information for the Office to allow reflective configuration by the OfficeFloorSource.

Parameters:

officeName - Name of the Office.

officeSource - OfficeSource instance.

location - Location of the Office.

properties - PropertyList to configure the OfficeSource.

Returns:

OfficeType or null if fails to load the OfficeType.