Package net.officefloor.compile.officefloor

Interface OfficeFloorLoader

All Known Implementing Classes:

OfficeFloorLoaderImpl

public interface OfficeFloorLoader

Loads the OfficeFloor from the OfficeFloorSource.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
<OF extends OfficeFloorSource> OfficeFloorType	loadOfficeFloorType(java.lang.Class<OF> officeFloorSourceClass, java.lang.String officeFloorLocation, PropertyList propertyList)	Loads the OfficeFloorType.
<OF extends OfficeFloorSource> OfficeFloorType	loadOfficeFloorType(OF officeFloorSource, java.lang.String officeFloorLocation, PropertyList propertyList)	Loads the OfficeFloorType.
<OF extends OfficeFloorSource> PropertyList	loadRequiredProperties(java.lang.Class<OF> officeFloorSourceClass, java.lang.String officeFloorLocation, PropertyList propertyList)	Loads the required PropertyList for the OfficeFloorSource configuration.
<OF extends OfficeFloorSource> PropertyList	loadSpecification(java.lang.Class<OF> officeFloorSourceClass)	Loads and returns the PropertyList from the OfficeFloorSourceSpecification for the OfficeFloorSource.

Method Detail

loadSpecification

<OF extends OfficeFloorSource> PropertyList loadSpecification(java.lang.Class<OF> officeFloorSourceClass)

Loads and returns the PropertyList from the OfficeFloorSourceSpecification for the OfficeFloorSource.

Type Parameters:

OF - OfficeFloorSource type.

Parameters:

officeFloorSourceClass - Class of the OfficeFloorSource.

Returns:

PropertyList of the OfficeFloorSourceProperty instances of the OfficeFloorSourceSpecification or null if issue, which is reported to the CompilerIssues.

loadRequiredProperties

<OF extends OfficeFloorSource> PropertyList loadRequiredProperties(java.lang.Class<OF> officeFloorSourceClass,
                                                                   java.lang.String officeFloorLocation,
                                                                   PropertyList propertyList)

Loads the required PropertyList for the OfficeFloorSource configuration.

These are additional Property instances over and above the OfficeFloorSourceSpecification that are required by the OfficeFloorSource to load the OfficeFloor. Typically these will be Property instances required by the configuration of the OfficeFloor.

Type Parameters:

OF - OfficeFloorSource type.

Parameters:

officeFloorSourceClass - Class of the OfficeFloorSource.

officeFloorLocation - Location of the OfficeFloor.

propertyList - PropertyList containing the properties as per the OfficeFloorSourceSpecification.

Returns:

Required PropertyList or null if issues, which are reported to the CompilerIssues.

loadOfficeFloorType

<OF extends OfficeFloorSource> OfficeFloorType loadOfficeFloorType(java.lang.Class<OF> officeFloorSourceClass,
                                                                   java.lang.String officeFloorLocation,
                                                                   PropertyList propertyList)

Loads the OfficeFloorType.

Type Parameters:

OF - OfficeFloorSource type.

Parameters:

officeFloorSourceClass - Class of the OfficeFloorSource.

officeFloorLocation - Location of the OfficeFloor.

propertyList - PropertyList containing both the OfficeFloorSourceProperty and required Property instances.

Returns:

OfficeFloorType or null if issues, which are reported to the CompilerIssues.

loadOfficeFloorType

<OF extends OfficeFloorSource> OfficeFloorType loadOfficeFloorType(OF officeFloorSource,
                                                                   java.lang.String officeFloorLocation,
                                                                   PropertyList propertyList)

Loads the OfficeFloorType.

Type Parameters:

OF - OfficeFloorSource type.

Parameters:

officeFloorSource - OfficeFloorSource.

officeFloorLocation - Location of the OfficeFloor.

propertyList - PropertyList containing both the OfficeFloorSourceProperty and required Property instances.

Returns:

OfficeFloorType or null if issues, which are reported to the CompilerIssues.