net.officefloor.plugin.work.clazz

Class ClassWorkSource

java.lang.Object

net.officefloor.compile.spi.work.source.impl.AbstractWorkSource<ClassWork>

net.officefloor.plugin.work.clazz.ClassWorkSource

All Implemented Interfaces:

WorkSource<ClassWork>, WorkSourceService<ClassWork,ClassWorkSource>

Direct Known Subclasses:

SectionClassWorkSource

public class ClassWorkSource
extends AbstractWorkSource<ClassWork>
implements WorkSourceService<ClassWork,ClassWorkSource>

WorkSource for a Class having the Object as the Work and Method instances as the Task instances.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ClassWorkSource.FlowInterfaceParameterManufacturer<A extends Annotation> ClassWorkSource.ParameterManufacturer for the FlowInterface.
protected static interface	ClassWorkSource.ParameterManufacturer Manufactures the ParameterFactory.
protected static class	ClassWorkSource.TaskContextParameterManufacturer ClassWorkSource.ParameterManufacturer for the TaskContext.

Nested classes/interfaces inherited from class net.officefloor.compile.spi.work.source.impl.AbstractWorkSource

AbstractWorkSource.SpecificationContext

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLASS_NAME_PROPERTY_NAME Property name providing the Class name.

Constructor Summary

Constructors

Constructor and Description
ClassWorkSource() Initiate.

Method Summary

Modifier and Type	Method and Description
protected TaskTypeBuilder<Indexed,Indexed>	addTaskType(Class<?> clazz, WorkTypeBuilder<ClassWork> workTypeBuilder, String taskName, TaskFactory<ClassWork,Indexed,Indexed> taskFactory, Sequence objectSequence, Sequence flowSequence) Allows overriding the addition of the TaskTypeBuilder.
protected TaskFactory<ClassWork,Indexed,Indexed>	createTaskFactory(Class<?> clazz, Method method, boolean isStatic, ParameterFactory[] parameters) Allows overriding the creation of the TaskFactory.
protected WorkFactory<ClassWork>	createWorkFactory(Class<?> clazz) Allows overriding the creation of the TaskFactory.
String	getWorkSourceAlias() Obtains the alias for the WorkSource Class.
Class<ClassWorkSource>	getWorkSourceClass() Obtains the WorkSource Class.
protected void	loadParameterManufacturers(List<ClassWorkSource.ParameterManufacturer> manufacturers) Override to add additional ClassWorkSource.ParameterManufacturer instances.
protected void	loadSpecification(AbstractWorkSource.SpecificationContext context) Loads the WorkSourceSpecification.
void	sourceWork(WorkTypeBuilder<ClassWork> workTypeBuilder, WorkSourceContext context) Sources the WorkType by populating it via the input WorkTypeBuilder.

Methods inherited from class net.officefloor.compile.spi.work.source.impl.AbstractWorkSource

getSpecification

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_NAME_PROPERTY_NAME

public static final String CLASS_NAME_PROPERTY_NAME

Property name providing the Class name.

See Also:

Constant Field Values

Constructor Detail

ClassWorkSource

public ClassWorkSource()

Initiate.

Method Detail

loadParameterManufacturers

protected void loadParameterManufacturers(List<ClassWorkSource.ParameterManufacturer> manufacturers)

Override to add additional ClassWorkSource.ParameterManufacturer instances.

Parameters:

manufacturers - List of ClassWorkSource.ParameterManufacturer instances to use.

createWorkFactory

protected WorkFactory<ClassWork> createWorkFactory(Class<?> clazz)

Allows overriding the creation of the TaskFactory.

Parameters:

clazz - Work class.

Returns:

WorkFactory.

createTaskFactory

protected TaskFactory<ClassWork,Indexed,Indexed> createTaskFactory(Class<?> clazz,
                                                                   Method method,
                                                                   boolean isStatic,
                                                                   ParameterFactory[] parameters)

Allows overriding the creation of the TaskFactory.

Parameters:

clazz - Work class.

method - Method on the class.

isStatic - Indicates if the Method is static.

parameters - ParameterFactory instances.

Returns:

TaskFactory.

addTaskType

protected TaskTypeBuilder<Indexed,Indexed> addTaskType(Class<?> clazz,
                                                       WorkTypeBuilder<ClassWork> workTypeBuilder,
                                                       String taskName,
                                                       TaskFactory<ClassWork,Indexed,Indexed> taskFactory,
                                                       Sequence objectSequence,
                                                       Sequence flowSequence)

Allows overriding the addition of the TaskTypeBuilder.

Parameters:

clazz - Work class.

workTypeBuilder - WorkTypeBuilder.

taskName - Name of the Task.

taskFactory - TaskFactory.

objectSequence - Object Sequence.

flowSequence - Flow Sequence.

Returns:

Added TaskTypeBuilder.

getWorkSourceAlias

public String getWorkSourceAlias()

Description copied from interface: WorkSourceService

Obtains the alias for the WorkSource Class.

Specified by:

getWorkSourceAlias in interface WorkSourceService<ClassWork,ClassWorkSource>

Returns:

Alias for the WorkSource Class.

getWorkSourceClass

public Class<ClassWorkSource> getWorkSourceClass()

Description copied from interface: WorkSourceService

Obtains the WorkSource Class.

Specified by:

getWorkSourceClass in interface WorkSourceService<ClassWork,ClassWorkSource>

Returns:

WorkSource Class.

loadSpecification

protected void loadSpecification(AbstractWorkSource.SpecificationContext context)

Description copied from class: AbstractWorkSource

Loads the WorkSourceSpecification.

Specified by:

loadSpecification in class AbstractWorkSource<ClassWork>

Parameters:

context - AbstractWorkSource.SpecificationContext.

sourceWork

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

Description copied from interface: WorkSource

Sources the WorkType by populating it via the input WorkTypeBuilder.

Specified by:

sourceWork in interface WorkSource<ClassWork>

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.