Package net.officefloor.web.template.type

Class WebTemplateLoaderImpl

java.lang.Object

net.officefloor.web.template.build.AbstractWebTemplateFactory

net.officefloor.web.template.type.WebTemplateLoaderImpl

All Implemented Interfaces:

SourceIssues, OfficeFloorCompilerRunnable<WebTemplateLoader>, WebTemplateFactory, WebTemplateLoader

public class WebTemplateLoaderImpl
extends AbstractWebTemplateFactory
implements OfficeFloorCompilerRunnable<WebTemplateLoader>, WebTemplateLoader, SourceIssues

WebTemplateLoader implementation.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor	Description
WebTemplateLoaderImpl()	Instantiate for OfficeFloorCompilerRunnable.

Method Summary

Modifier and Type	Method	Description
CompileError	addIssue(String issueDescription)	Allows the source to add an issue.
CompileError	addIssue(String issueDescription, Throwable cause)	Allows the source to add an issue along with its cause.
protected WebTemplate	addTemplate(boolean isSecure, String applicationPath, PropertyList properties)	Adds the WebTemplate.
protected PropertyList	createPropertyList()	Creates a PropertyList.
protected SourceIssues	getSourceIssues()	Obtains the SourceIssues.
protected boolean	isPathParameters(String applicationPath)	Indicates if path parameters.
WebTemplateType	loadWebTemplateType(WebTemplate webTemplate)	Loads the WebTemplateType for the WebTemplate.
WebTemplateLoader	run(OfficeFloorCompiler compiler, Object[] parameters)	Contains the runnable functionality.

Methods inherited from class net.officefloor.web.template.build.AbstractWebTemplateFactory

addTemplate, addTemplate

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.officefloor.web.template.build.WebTemplateFactory

addTemplate, addTemplate

Constructor Details

WebTemplateLoaderImpl

public WebTemplateLoaderImpl()

Instantiate for OfficeFloorCompilerRunnable.

Method Details

run

public WebTemplateLoader run(OfficeFloorCompiler compiler,
 Object[] parameters)
                      throws Exception

Description copied from interface: OfficeFloorCompilerRunnable

Contains the runnable functionality.

Specified by:

run in interface OfficeFloorCompilerRunnable<WebTemplateLoader>

Parameters:

compiler - OfficeFloorCompiler loaded with the ClassLoader.

parameters - Parameters. As Proxy instances are used to bridge Class compatibility issues of using different ClassLoader instances, parameters should only be referenced by their implementing interfaces.

Returns:

Result from runnable.

Throws:

Exception - If failure in running.

addIssue

public CompileError addIssue(String issueDescription)

Description copied from interface: SourceIssues

Allows the source to add an issue.

This is available to report invalid configuration.

Specified by:

addIssue in interface SourceIssues

Parameters:

issueDescription - Description of the issue.

Returns:

CompileError to be used in throw statement when adding CompilerIssue to avoid further compiling.

addIssue

public CompileError addIssue(String issueDescription,
 Throwable cause)

Description copied from interface: SourceIssues

Allows the source to add an issue along with its cause.

This is available to report invalid configuration.

Specified by:

addIssue in interface SourceIssues

Parameters:

issueDescription - Description of the issue.

cause - Cause of the issue.

Returns:

CompileError to be used in throw statement when adding CompilerIssue to avoid further compiling.

createPropertyList

protected PropertyList createPropertyList()

Description copied from class: AbstractWebTemplateFactory

Creates a PropertyList.

Specified by:

createPropertyList in class AbstractWebTemplateFactory

Returns:

New PropertyList.

getSourceIssues

protected SourceIssues getSourceIssues()

Description copied from class: AbstractWebTemplateFactory

Obtains the SourceIssues.

Specified by:

getSourceIssues in class AbstractWebTemplateFactory

Returns:

SourceIssues.

isPathParameters

protected boolean isPathParameters(String applicationPath)

Description copied from class: AbstractWebTemplateFactory

Indicates if path parameters.

Specified by:

isPathParameters in class AbstractWebTemplateFactory

Parameters:

applicationPath - Application path.

Returns:

true if path parameters.

addTemplate

protected WebTemplate addTemplate(boolean isSecure,
 String applicationPath,
 PropertyList properties)

Description copied from class: AbstractWebTemplateFactory

Adds the WebTemplate.

Specified by:

addTemplate in class AbstractWebTemplateFactory

Parameters:

isSecure - Indicates if requires secure ServerHttpConnection to render the WebTemplate.

applicationPath - Application path to the WebTemplate. May contain path parameters.

properties - Initial Properties for the WebTemplate that should be further configured by the returned WebTemplate implementation.

Returns:

WebTemplate.

loadWebTemplateType

public WebTemplateType loadWebTemplateType(WebTemplate webTemplate)

Description copied from interface: WebTemplateLoader

Loads the WebTemplateType for the WebTemplate.

Specified by:

loadWebTemplateType in interface WebTemplateLoader

Parameters:

webTemplate - Configured WebTemplate to provide the type information.

Returns:

WebTemplateType for the WebTemplate.