Package net.officefloor.compile.test.section

Class SectionLoaderUtil

java.lang.Object

net.officefloor.compile.test.section.SectionLoaderUtil

public class SectionLoaderUtil
extends java.lang.Object

Utility class for testing a SectionSource.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
static SectionType	buildSectionType(SectionDesigner designer)	Builds the SectionType for the SectionDesigner.
static SectionDesigner	createSectionDesigner()	Creates the SectionDesigner to create the expected SectionType/OfficeSection.
static SectionTypeBuilder	createSectionTypeBuilder()	Creates the SectionTypeBuilder.
static java.lang.String	getClassPathLocation(java.lang.Class<?> offsetClass, java.lang.String resourceName)	Convenience method to obtain the class path location.
static <S extends SectionSource> OfficeSectionType	loadOfficeSectionType(java.lang.String sectionName, java.lang.Class<S> sectionSourceClass, java.lang.String sectionLocation, java.lang.String... propertyNameValuePairs)	Convenience method to load the OfficeSectionType.
static <S extends SectionSource> SectionType	loadSectionType(java.lang.Class<S> sectionSourceClass, java.lang.String sectionLocation, java.lang.String... propertyNameValuePairs)	Convenience method to load the SectionType.
static SectionType	loadSectionType(SectionSource sectionSource, java.lang.String sectionLocation, java.lang.String... propertyNameValuePairs)	Convenience method to load the SectionType.
static <S extends SectionSource> void	validateOfficeSection(SectionDesigner designer, java.lang.Class<S> sectionSourceClass, java.lang.String sectionLocation, java.lang.String... propertyNameValuePairs)	Convenience method that validates the loaded OfficeSection against expected OfficeSection from the SectionDesigner.
static <S extends SectionSource> void	validateSection(SectionDesigner designer, java.lang.Class<S> sectionSourceClass, java.lang.Class<?> offsetClass, java.lang.String resourceName, java.lang.String... propertyNameValuePairs)	Facade method to validate the SectionType and OfficeSection.
static <S extends SectionSource> void	validateSection(SectionDesigner designer, java.lang.Class<S> sectionSourceClass, java.lang.String sectionLocation, java.lang.String... propertyNameValuePairs)	Convenience method that validates both the loaded SectionType and OfficeSection against expected SectionType/ OfficeSection from the SectionDesigner.
static <S extends SectionSource> void	validateSectionType(SectionDesigner designer, java.lang.Class<S> sectionSourceClass, java.lang.String sectionLocation, java.lang.String... propertyNameValuePairs)	Convenience method that validates the loaded SectionType against expected SectionType from the SectionDesigner.
static void	validateSectionType(SectionDesigner designer, SectionType actualSection)	Validates the SectionType.
static void	validateSectionType(SectionDesigner designer, SectionSource sectionSource, java.lang.String sectionLocation, java.lang.String... propertyNameValuePairs)	Convenience method that validates the loaded SectionType against expected SectionType from the SectionDesigner.
static <S extends SectionSource> PropertyList	validateSpecification(java.lang.Class<S> sectionSourceClass, java.lang.String... propertyNameLabels)	Validates the SectionSourceSpecification for the SectionSource.
static PropertyList	validateSpecification(SectionSource sectionSource, java.lang.String... propertyNameLabels)	Validates the SectionSourceSpecification for the SectionSource.

Methods inherited from class java.lang.Object

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

Method Detail

validateSpecification

public static <S extends SectionSource> PropertyList validateSpecification(java.lang.Class<S> sectionSourceClass,
                                                                           java.lang.String... propertyNameLabels)

Validates the SectionSourceSpecification for the SectionSource.

Type Parameters:

S - SectionSource type.

Parameters:

sectionSourceClass - SectionSource class.

propertyNameLabels - Listing of name/label pairs for the Property instances.

Returns:

Loaded PropertyList.

validateSpecification

public static PropertyList validateSpecification(SectionSource sectionSource,
                                                 java.lang.String... propertyNameLabels)

Validates the SectionSourceSpecification for the SectionSource.

Parameters:

sectionSource - SectionSource.

propertyNameLabels - Listing of name/label pairs for the Property instances.

Returns:

Loaded PropertyList.

getClassPathLocation

public static java.lang.String getClassPathLocation(java.lang.Class<?> offsetClass,
                                                    java.lang.String resourceName)

Convenience method to obtain the class path location.

Parameters:

offsetClass - Class indicating the package that the resource is within. Typically this will be the Assert instance.

resourceName - Name of the resource.

Returns:

Class path location of the resource.

createSectionDesigner

public static SectionDesigner createSectionDesigner()

Creates the SectionDesigner to create the expected SectionType/OfficeSection.

Returns:

SectionDesigner.

createSectionTypeBuilder

public static SectionTypeBuilder createSectionTypeBuilder()

Creates the SectionTypeBuilder.

Returns:

SectionTypeBuilder.

buildSectionType

public static SectionType buildSectionType(SectionDesigner designer)

Builds the SectionType for the SectionDesigner.

Parameters:

designer - SectionDesigner.

Returns:

SectionType.

validateSection

public static <S extends SectionSource> void validateSection(SectionDesigner designer,
                                                             java.lang.Class<S> sectionSourceClass,
                                                             java.lang.Class<?> offsetClass,
                                                             java.lang.String resourceName,
                                                             java.lang.String... propertyNameValuePairs)

Facade method to validate the SectionType and OfficeSection.

Type Parameters:

S - SectionSource type.

Parameters:

designer - SectionDesigner containing the expected SectionType/OfficeSection.

sectionSourceClass - Class of the SectionSource being tested.

offsetClass - Object indicating the package that the resource is within. Typically this will be the Assert instance.

resourceName - Name of the resource. This is used with the offsetObject to determine the OfficeSection location.

propertyNameValuePairs - Listing of Property name/value pairs.

validateSection

public static <S extends SectionSource> void validateSection(SectionDesigner designer,
                                                             java.lang.Class<S> sectionSourceClass,
                                                             java.lang.String sectionLocation,
                                                             java.lang.String... propertyNameValuePairs)

Convenience method that validates both the loaded SectionType and OfficeSection against expected SectionType/ OfficeSection from the SectionDesigner.

Type Parameters:

S - SectionSource type.

Parameters:

designer - SectionDesigner containing the expected SectionType/OfficeSection.

sectionSourceClass - Class of the SectionSource being tested.

sectionLocation - Location of the OfficeSection.

propertyNameValuePairs - Listing of Property name/value pairs.

validateSectionType

public static void validateSectionType(SectionDesigner designer,
                                       SectionSource sectionSource,
                                       java.lang.String sectionLocation,
                                       java.lang.String... propertyNameValuePairs)

Convenience method that validates the loaded SectionType against expected SectionType from the SectionDesigner.

Parameters:

designer - SectionDesigner containing the expected SectionType.

sectionSource - SectionSource instance being tested.

sectionLocation - Location of the OfficeSection.

propertyNameValuePairs - Listing of Property name/value pairs.

validateSectionType

public static <S extends SectionSource> void validateSectionType(SectionDesigner designer,
                                                                 java.lang.Class<S> sectionSourceClass,
                                                                 java.lang.String sectionLocation,
                                                                 java.lang.String... propertyNameValuePairs)

Convenience method that validates the loaded SectionType against expected SectionType from the SectionDesigner.

Type Parameters:

S - SectionSource type.

Parameters:

designer - SectionDesigner containing the expected SectionType.

sectionSourceClass - Class of the SectionSource being tested.

sectionLocation - Location of the OfficeSection.

propertyNameValuePairs - Listing of Property name/value pairs.

validateSectionType

public static void validateSectionType(SectionDesigner designer,
                                       SectionType actualSection)

Validates the SectionType.

Parameters:

designer - SectionDesigner containing the expected SectionType.

actualSection - Actual SectionType to validate.

validateOfficeSection

public static <S extends SectionSource> void validateOfficeSection(SectionDesigner designer,
                                                                   java.lang.Class<S> sectionSourceClass,
                                                                   java.lang.String sectionLocation,
                                                                   java.lang.String... propertyNameValuePairs)

Convenience method that validates the loaded OfficeSection against expected OfficeSection from the SectionDesigner.

Type Parameters:

S - SectionSource type.

Parameters:

designer - SectionDesigner containing the expected OfficeSection.

sectionSourceClass - Class of the SectionSource being tested.

sectionLocation - Location of the OfficeSection.

propertyNameValuePairs - Listing of Property name/value pairs.

loadSectionType

public static <S extends SectionSource> SectionType loadSectionType(java.lang.Class<S> sectionSourceClass,
                                                                    java.lang.String sectionLocation,
                                                                    java.lang.String... propertyNameValuePairs)

Convenience method to load the SectionType. It uses the SectionSource class's ClassLoader and subsequent ClassLoaderConfigurationContext.

Type Parameters:

S - SectionSource type.

Parameters:

sectionSourceClass - Class of the SectionSource.

sectionLocation - Location of the OfficeSection.

propertyNameValuePairs - Listing of Property name/value pairs.

Returns:

SectionType.

loadSectionType

public static SectionType loadSectionType(SectionSource sectionSource,
                                          java.lang.String sectionLocation,
                                          java.lang.String... propertyNameValuePairs)

Convenience method to load the SectionType.

Parameters:

sectionSource - SectionSource instance.

sectionLocation - Location of the OfficeSection.

propertyNameValuePairs - Listing of Property name/value pairs.

Returns:

SectionType.

loadOfficeSectionType

public static <S extends SectionSource> OfficeSectionType loadOfficeSectionType(java.lang.String sectionName,
                                                                                java.lang.Class<S> sectionSourceClass,
                                                                                java.lang.String sectionLocation,
                                                                                java.lang.String... propertyNameValuePairs)

Convenience method to load the OfficeSectionType. It uses the SectionSource class's ClassLoader and subsequent ClassLoaderConfigurationContext.

Type Parameters:

S - SectionSource type.

Parameters:

sectionName - Name of the OfficeSection.

sectionSourceClass - Class of the SectionSource.

sectionLocation - Location of the OfficeSection.

propertyNameValuePairs - Listing of Property name/value pairs.

Returns:

OfficeSectionType.