Package net.officefloor.woof.template

Class WoofTemplateExtensionLoaderUtil

java.lang.Object

net.officefloor.woof.template.WoofTemplateExtensionLoaderUtil

public class WoofTemplateExtensionLoaderUtil
extends java.lang.Object

Utility functions for testing a WoofTemplateExtensionSource implementation.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
static SourceProperties	createSourceProperties(java.lang.String... propertyNameValues)	Creates the SourceProperties.
static <S extends WoofTemplateExtensionSource> void	extendTemplate(java.lang.Class<S> extensionSourceClass, java.lang.String templatePath, WebTemplate template, OfficeArchitect officeArchitect, WebArchitect webArchitect, java.lang.ClassLoader classLoader, ResourceSource[] resourceSources, java.lang.String... propertyNameValues)	Undertakes the extending of the WebTemplate by the WoofTemplateExtensionSource.
static <S extends WoofTemplateExtensionSource> void	extendTemplate(java.lang.Class<S> extensionSourceClass, java.lang.String applicationPath, WebTemplate template, OfficeArchitect officeArchitect, WebArchitect webArchitect, java.lang.String... propertyNameValues)	Undertakes the extending of the WebTemplate by the WoofTemplateExtensionSource.
static WoofChangeIssues	getWoofChangeIssues()	Obtains the WoofChangeIssues.
static <S extends WoofTemplateExtensionSource> Change<?>	refactorTemplateExtension(java.lang.Class<S> woofTemplateExtensionSourceClass, java.lang.String oldUri, SourceProperties oldProperties, java.lang.String newUri, SourceProperties newProperties)	Creates the Change for refactoring.
static <S extends WoofTemplateExtensionSource> Change<?>	refactorTemplateExtension(java.lang.Class<S> woofTemplateExtensionSourceClass, java.lang.String oldUri, SourceProperties oldProperties, java.lang.String newUri, SourceProperties newProperties, ConfigurationContext configurationContext, java.lang.ClassLoader classLoader, ResourceSource... resourceSources)	Creates the Change for refactoring.
static void	validateConfigurationItem(ConfigurationContext context, java.lang.String location, java.io.Reader content)	Convenience method to validate the ConfigurationItem.
static void	validateConfigurationItem(ConfigurationContext context, java.lang.String location, java.lang.String content)	Convenience method to validate the ConfigurationItem.
static <S extends WoofTemplateExtensionSource> PropertyList	validateSpecification(java.lang.Class<S> woofTemplateExtensionSourceClass, java.lang.ClassLoader classLoader, java.lang.String... propertyNameLabels)	Validates the WoofTemplateExtensionSourceSpecification for the WoofTemplateExtensionSource.
static <S extends WoofTemplateExtensionSource> PropertyList	validateSpecification(java.lang.Class<S> woofTemplateExtensionSourceClass, java.lang.String... propertyNameLabels)	Validates the WoofTemplateExtensionSourceSpecification for the WoofTemplateExtensionSource.

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 WoofTemplateExtensionSource> PropertyList validateSpecification(java.lang.Class<S> woofTemplateExtensionSourceClass,
                                                                                         java.lang.String... propertyNameLabels)

Validates the WoofTemplateExtensionSourceSpecification for the WoofTemplateExtensionSource.

Type Parameters:

S - WoofTemplateExtensionSource type.

Parameters:

woofTemplateExtensionSourceClass - WoofTemplateExtensionSource class.

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

Returns:

Loaded PropertyList.

validateSpecification

public static <S extends WoofTemplateExtensionSource> PropertyList validateSpecification(java.lang.Class<S> woofTemplateExtensionSourceClass,
                                                                                         java.lang.ClassLoader classLoader,
                                                                                         java.lang.String... propertyNameLabels)

Validates the WoofTemplateExtensionSourceSpecification for the WoofTemplateExtensionSource.

Type Parameters:

S - WoofTemplateExtensionSource type.

Parameters:

woofTemplateExtensionSourceClass - WoofTemplateExtensionSource class.

classLoader - ClassLoader. May be null.

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

Returns:

Loaded PropertyList.

createSourceProperties

public static SourceProperties createSourceProperties(java.lang.String... propertyNameValues)

Creates the SourceProperties.

Parameters:

propertyNameValues - Property name/value pairs.

Returns:

SourceProperties.

getWoofChangeIssues

public static WoofChangeIssues getWoofChangeIssues()

Obtains the WoofChangeIssues.

Returns:

WoofChangeIssues.

refactorTemplateExtension

public static <S extends WoofTemplateExtensionSource> Change<?> refactorTemplateExtension(java.lang.Class<S> woofTemplateExtensionSourceClass,
                                                                                          java.lang.String oldUri,
                                                                                          SourceProperties oldProperties,
                                                                                          java.lang.String newUri,
                                                                                          SourceProperties newProperties)

Creates the Change for refactoring.

Type Parameters:

S - WoofTemplateExtensionSource type.

Parameters:

woofTemplateExtensionSourceClass - WoofTemplateExtensionSource class.

oldUri - Old URI.

oldProperties - Old SourceProperties.

newUri - New URI.

newProperties - New SourceProperties.

Returns:

Change for refactoring. May be null.

refactorTemplateExtension

public static <S extends WoofTemplateExtensionSource> Change<?> refactorTemplateExtension(java.lang.Class<S> woofTemplateExtensionSourceClass,
                                                                                          java.lang.String oldUri,
                                                                                          SourceProperties oldProperties,
                                                                                          java.lang.String newUri,
                                                                                          SourceProperties newProperties,
                                                                                          ConfigurationContext configurationContext,
                                                                                          java.lang.ClassLoader classLoader,
                                                                                          ResourceSource... resourceSources)

Creates the Change for refactoring.

Type Parameters:

S - WoofTemplateExtensionSource type.

Parameters:

woofTemplateExtensionSourceClass - WoofTemplateExtensionSource class.

oldUri - Old URI.

oldProperties - Old SourceProperties.

newUri - New URI.

newProperties - New SourceProperties.

configurationContext - ConfigurationContext. May be null.

classLoader - ClassLoader.

resourceSources - ResourceSource instances.

Returns:

Change for refactoring. May be null.

validateConfigurationItem

public static void validateConfigurationItem(ConfigurationContext context,
                                             java.lang.String location,
                                             java.lang.String content)
                                      throws java.lang.Exception

Convenience method to validate the ConfigurationItem.

Parameters:

context - ConfigurationContext.

location - Location of the ConfigurationItem.

content - Expected content of the ConfigurationItem. May be null to indicate no expecting ConfigurationItem.

Throws:

java.lang.Exception - If failure in accessing ConfigurationItem.

validateConfigurationItem

public static void validateConfigurationItem(ConfigurationContext context,
                                             java.lang.String location,
                                             java.io.Reader content)
                                      throws java.lang.Exception

Convenience method to validate the ConfigurationItem.

Parameters:

context - ConfigurationContext.

location - Location of the ConfigurationItem.

content - Expected content of the ConfigurationItem. May be null to indicate no expecting ConfigurationItem.

Throws:

java.lang.Exception - If fails accessing the ConfigurationItem.

extendTemplate

public static <S extends WoofTemplateExtensionSource> void extendTemplate(java.lang.Class<S> extensionSourceClass,
                                                                          java.lang.String applicationPath,
                                                                          WebTemplate template,
                                                                          OfficeArchitect officeArchitect,
                                                                          WebArchitect webArchitect,
                                                                          java.lang.String... propertyNameValues)
                                                                   throws java.lang.Exception

Undertakes the extending of the WebTemplate by the WoofTemplateExtensionSource.

Type Parameters:

S - WoofTemplateExtensionSource type.

Parameters:

extensionSourceClass - WoofTemplateExtensionSource class.

applicationPath - Application path to the WebTemplate.

template - WebTemplate.

officeArchitect - OfficeArchitect.

webArchitect - WebArchitect.

propertyNameValues - Property name/value pairs.

Throws:

java.lang.Exception - If fails to extend WebTemplate.

extendTemplate

public static <S extends WoofTemplateExtensionSource> void extendTemplate(java.lang.Class<S> extensionSourceClass,
                                                                          java.lang.String templatePath,
                                                                          WebTemplate template,
                                                                          OfficeArchitect officeArchitect,
                                                                          WebArchitect webArchitect,
                                                                          java.lang.ClassLoader classLoader,
                                                                          ResourceSource[] resourceSources,
                                                                          java.lang.String... propertyNameValues)
                                                                   throws java.lang.Exception

Undertakes the extending of the WebTemplate by the WoofTemplateExtensionSource.

Type Parameters:

S - WoofTemplateExtensionSource type.

Parameters:

extensionSourceClass - WoofTemplateExtensionSource class.

templatePath - URL path to the WebTemplate.

template - WebTemplate.

officeArchitect - OfficeArchitect.

webArchitect - WebArchitect.

classLoader - ClassLoader. May be null.

resourceSources - ResourceSource instances. May be null.

propertyNameValues - Property name/value pairs.

Throws:

java.lang.Exception - If fails to extend WebTemplate.