net.officefloor.eclipse.socket
Class AbstractSocketWorkSourceExtension<W extends Work,S extends WorkSource<W>>

java.lang.Object
  net.officefloor.eclipse.socket.AbstractSocketWorkSourceExtension<W,S>

All Implemented Interfaces:

ExtensionClasspathProvider, WorkSourceExtension<W,S>

Direct Known Subclasses:

HttpFileFactoryWorkSourceExtension, HttpFileSenderWorkSourceExtension, HttpParametersLoaderWorkSourceExtension, HttpResponseSenderWorkSourceExtension, HttpRouteWorkSourceExtension, HttpTemplateWorkSourceExtension

public abstract class AbstractSocketWorkSourceExtension<W extends Work,S extends WorkSource<W>>
extends Object
implements WorkSourceExtension<W,S>, ExtensionClasspathProvider

Provides abstract functionality for a source extension.

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

AbstractSocketWorkSourceExtension(Class<S> workSourceClass, String workSourceLabel)
Initiate.

Method Summary

ClasspathProvision[]	getClasspathProvisions() Obtains the ClasspathProvision instances for the extension.
String	getSuggestedWorkName(PropertyList properties) Obtains the suggested name of the Work.
Class<S>	getWorkSourceClass() Obtains the class of the WorkSource being enriched in its usage.
String	getWorkSourceLabel() Obtains the label for the WorkSource.

Methods inherited from class java.lang.Object

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

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

createControl, getTaskDocumentation

Constructor Detail

AbstractSocketWorkSourceExtension

public AbstractSocketWorkSourceExtension(Class<S> workSourceClass,
                                         String workSourceLabel)

Initiate.

Parameters:

workSourceClass - WorkSource class.

workSourceLabel - Label for the WorkSource.

Method Detail

getClasspathProvisions

public ClasspathProvision[] getClasspathProvisions()

Description copied from interface: ExtensionClasspathProvider

Obtains the ClasspathProvision instances for the extension.

Specified by:

getClasspathProvisions in interface ExtensionClasspathProvider

Returns:

ClasspathProvision instances for the extension.

getWorkSourceClass

public Class<S> getWorkSourceClass()

Description copied from interface: WorkSourceExtension

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

Specified by:

getWorkSourceClass in interface WorkSourceExtension<W extends Work,S extends WorkSource<W>>

Returns:

Class of the WorkSource being enriched in its usage.

getWorkSourceLabel

public String getWorkSourceLabel()

Description copied from interface: WorkSourceExtension

Obtains the label for the WorkSource.

This is a descriptive name that can be used other than the fully qualified name of the WorkSource.

Specified by:

getWorkSourceLabel in interface WorkSourceExtension<W extends Work,S extends WorkSource<W>>

Returns:

Label for the WorkSource.

getSuggestedWorkName

public String getSuggestedWorkName(PropertyList properties)

Description copied from interface: WorkSourceExtension

Obtains the suggested name of the Work.

Specified by:

getSuggestedWorkName in interface WorkSourceExtension<W extends Work,S extends WorkSource<W>>

Parameters:

properties - PropertyList.

Returns:

Suggested Work name or null if no suggestion.