Package net.officefloor.woof.template

Interface WoofTemplateExtensionLoader

All Known Implementing Classes:

WoofTemplateExtensionLoaderImpl

public interface WoofTemplateExtensionLoader

Loads the extension from the WoofTemplateExtensionSource.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
void	extendTemplate(WoofTemplateExtensionSource extensionSource, PropertyList properties, java.lang.String applicationPath, WebTemplate template, OfficeArchitect officeArchitect, WebArchitect webArchitect, SourceContext sourceContext)	Extends the WebTemplate with the WoofTemplateExtensionSource.
PropertyList	loadSpecification(java.lang.String woofTemplateExtensionSourceClassName, java.lang.ClassLoader classLoader, CompilerIssues issues)	Loads and returns the PropertyList from the WoofTemplateExtensionSourceSpecification for the WoofTemplateExtensionSource.
Change<?>	refactorTemplateExtension(java.lang.String woofTemplateExtensionSourceClassName, java.lang.String oldUri, SourceProperties oldProperties, java.lang.String newUri, SourceProperties newProperties, ConfigurationContext configurationContext, SourceContext sourceContext, WoofChangeIssues issues)	Refactors the WoofTemplateExtensionSource for the WoofTemplateModel.

Method Detail

loadSpecification

PropertyList loadSpecification(java.lang.String woofTemplateExtensionSourceClassName,
                               java.lang.ClassLoader classLoader,
                               CompilerIssues issues)

Loads and returns the PropertyList from the WoofTemplateExtensionSourceSpecification for the WoofTemplateExtensionSource.

Parameters:

woofTemplateExtensionSourceClassName - WoofTemplateExtensionSource class name.

classLoader - ClassLoader to use in loading the specification.

issues - CompilerIssues to report any issues in attempting to obtain the PropertyList.

Returns:

PropertyList of the WoofTemplateExtensionSourceProperty instances of the WoofTemplateExtensionSourceSpecification or null if issue, which is reported to the CompilerIssues.

refactorTemplateExtension

Change<?> refactorTemplateExtension(java.lang.String woofTemplateExtensionSourceClassName,
                                    java.lang.String oldUri,
                                    SourceProperties oldProperties,
                                    java.lang.String newUri,
                                    SourceProperties newProperties,
                                    ConfigurationContext configurationContext,
                                    SourceContext sourceContext,
                                    WoofChangeIssues issues)

Refactors the WoofTemplateExtensionSource for the WoofTemplateModel.

Parameters:

woofTemplateExtensionSourceClassName - WoofTemplateExtensionSource class name.

oldUri - Old URI. May be null if adding WoofTemplateExtensionSource.

oldProperties - Old SourceProperties.

newUri - New URI. May be null if removing the WoofTemplateExtensionSource.

newProperties - New SourceProperties.

configurationContext - ConfigurationContext.

sourceContext - SourceContext.

issues - WoofChangeIssues.

Returns:

Change to refactor the WoofTemplateExtensionSource for the WoofTemplateModel.

extendTemplate

void extendTemplate(WoofTemplateExtensionSource extensionSource,
                    PropertyList properties,
                    java.lang.String applicationPath,
                    WebTemplate template,
                    OfficeArchitect officeArchitect,
                    WebArchitect webArchitect,
                    SourceContext sourceContext)
             throws WoofTemplateExtensionException

Extends the WebTemplate with the WoofTemplateExtensionSource.

Parameters:

extensionSource - WoofTemplateExtensionSource.

properties - PropertyList to configure the WoofTemplateExtensionSource.

applicationPath - Application path to the WebTemplate.

template - WebTemplate to be extended.

officeArchitect - OfficeArchitect.

webArchitect - WebArchitect.

sourceContext - SourceContext.

Throws:

WoofTemplateExtensionException - If fails to extend the WebTemplate.