net.officefloor.eclipse.socket

Class HttpParametersLoaderWorkSourceExtension

java.lang.Object

net.officefloor.eclipse.socket.AbstractSocketWorkSourceExtension<HttpParametersLoaderWorkSource.HttpParametersLoaderTask,HttpParametersLoaderWorkSource>

net.officefloor.eclipse.socket.HttpParametersLoaderWorkSourceExtension

All Implemented Interfaces:

ExtensionClasspathProvider, WorkSourceExtension<HttpParametersLoaderWorkSource.HttpParametersLoaderTask,HttpParametersLoaderWorkSource>

public class HttpParametersLoaderWorkSourceExtension
extends AbstractSocketWorkSourceExtension<HttpParametersLoaderWorkSource.HttpParametersLoaderTask,HttpParametersLoaderWorkSource>

WorkSourceExtension for the HttpParametersLoaderWorkSource.

Author:

Daniel Sagenschneider

Field Summary

Fields inherited from interface net.officefloor.eclipse.extension.worksource.WorkSourceExtension

EXTENSION_ID

Fields inherited from interface net.officefloor.eclipse.extension.classpath.ExtensionClasspathProvider

EXTENSION_ID

Constructor Summary

Constructors

Constructor and Description
HttpParametersLoaderWorkSourceExtension() Initiate.

Method Summary

Modifier and Type	Method and Description
void	createControl(org.eclipse.swt.widgets.Composite page, WorkSourceExtensionContext context) Loads the input page with the necessary Control instances to populate the PropertyList.
String	getSuggestedWorkName(PropertyList properties) Obtains the suggested name of the Work.
String	getTaskDocumentation(TaskDocumentationContext context) Obtains documentation about a Task of the Work.
Class<HttpParametersLoaderWorkSource>	getWorkSourceClass() Obtains the class of the WorkSource being enriched in its usage.

Methods inherited from class net.officefloor.eclipse.socket.AbstractSocketWorkSourceExtension

getClasspathProvisions, getWorkSourceLabel

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpParametersLoaderWorkSourceExtension

public HttpParametersLoaderWorkSourceExtension()

Initiate.

Method Detail

getWorkSourceClass

public Class<HttpParametersLoaderWorkSource> getWorkSourceClass()

Description copied from interface: WorkSourceExtension

Obtains the class of the WorkSource being enriched in its usage.

Specified by:

getWorkSourceClass in interface WorkSourceExtension<HttpParametersLoaderWorkSource.HttpParametersLoaderTask,HttpParametersLoaderWorkSource>

Overrides:

getWorkSourceClass in class AbstractSocketWorkSourceExtension<HttpParametersLoaderWorkSource.HttpParametersLoaderTask,HttpParametersLoaderWorkSource>

Returns:

Class of the WorkSource being enriched in its usage.

createControl

public void createControl(org.eclipse.swt.widgets.Composite page,
                          WorkSourceExtensionContext context)

Description copied from interface: WorkSourceExtension

Loads the input page with the necessary Control instances to populate the PropertyList. Also allows notifying of changes to Property instances via the WorkSourceExtensionContext.

Parameters:

page - Page to be setup for populating the PropertyList.

context - WorkSourceExtensionContext.

getSuggestedWorkName

public String getSuggestedWorkName(PropertyList properties)

Description copied from interface: WorkSourceExtension

Obtains the suggested name of the Work.

Specified by:

getSuggestedWorkName in interface WorkSourceExtension<HttpParametersLoaderWorkSource.HttpParametersLoaderTask,HttpParametersLoaderWorkSource>

Overrides:

getSuggestedWorkName in class AbstractSocketWorkSourceExtension<HttpParametersLoaderWorkSource.HttpParametersLoaderTask,HttpParametersLoaderWorkSource>

Parameters:

properties - PropertyList.

Returns:

Suggested Work name or null if no suggestion.

getTaskDocumentation

public String getTaskDocumentation(TaskDocumentationContext context)
                            throws Throwable

Description copied from interface: WorkSourceExtension

Obtains documentation about a Task of the Work.

Parameters:

context - TaskDocumentationContext.

Returns:

Documentation about the Task.

Throws:

Throwable - If fails to obtain documentation about the Task.