net.officefloor.compile.spi.work.source

Interface WorkSource<W extends Work>

All Known Implementing Classes:

AbstractWorkSource, AutoWireEscalationCauseRouteWorkSource, ClassWorkSource, HttpFileFactoryWorkSource, HttpFileSenderWorkSource, HttpFileWorkSource, HttpFileWriterWorkSource, HttpParametersLoaderWorkSource, HttpResponseSenderWorkSource, HttpRouteWorkSource, HttpSecurityWorkSource, HttpServletWorkSource, HttpTemplateArrayIteratorWorkSource, HttpTemplateInitialWorkSource, HttpTemplateWorkSource, HttpUrlContinuationWorkSource, JndiWorkSource, JspWorkSource, SectionClassWorkSource, ServletContainerResourceSectionSource.ServletContainerResourceWorkSource, ServletRouteWorkSource

public interface WorkSource<W extends Work>

Sources the WorkType.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method and Description
WorkSourceSpecification	getSpecification() Obtains the WorkSourceSpecification for this WorkSource.
void	sourceWork(WorkTypeBuilder<W> workTypeBuilder, WorkSourceContext context) Sources the WorkType by populating it via the input WorkTypeBuilder.

Method Detail

getSpecification

WorkSourceSpecification getSpecification()

Obtains the WorkSourceSpecification for this WorkSource.

This enables the WorkSourceContext to be populated with the necessary details as per this WorkSourceSpecification in loading the WorkType.

Returns:

WorkSourceSpecification.

sourceWork

void sourceWork(WorkTypeBuilder<W> workTypeBuilder,
                WorkSourceContext context)
         throws Exception

Sources the WorkType by populating it via the input WorkTypeBuilder.

Parameters:

workTypeBuilder - WorkTypeBuilder to be populated with the type definition of the Work.

context - WorkSourceContext to source details to populate the WorkTypeBuilder.

Throws:

Exception - If fails to populate the WorkTypeBuilder.