P
- the parameter type@Immutable public abstract class AbstractFunction<P extends AbstractParameter> extends Object implements Function
IConfigurationElement
based function base classModifier and Type | Field and Description |
---|---|
protected org.eclipse.core.runtime.IConfigurationElement |
conf
The configuration element
|
Modifier | Constructor and Description |
---|---|
protected |
AbstractFunction(org.eclipse.core.runtime.IConfigurationElement conf)
Create a function definition based on the given configuration element
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
String |
getCategoryId()
Get the ID of the function's category
|
Collection<FunctionParameter> |
getDefinedParameters()
Get the defined parameters for the function
|
String |
getDefiningBundle()
Get the symbolic name of the bundle defining the function.
|
String |
getDescription()
Get the function description
|
String |
getDisplayName()
Get the human readable name of the function
|
CellExplanation |
getExplanation()
Get the associated cell explanation.
|
URL |
getHelpURL()
Get the help file URL
|
URL |
getIconURL()
Get the icon URL
|
String |
getId() |
FunctionParameter |
getParameter(String paramName)
Get the function parameter with the given name.
|
abstract Set<? extends P> |
getSource()
Get the source entities
|
abstract Set<? extends P> |
getTarget()
Get the target entities
|
int |
hashCode() |
boolean |
isAugmentation()
States if the function represents an augmentation of a target instance
instead of a transformation.
|
protected final org.eclipse.core.runtime.IConfigurationElement conf
protected AbstractFunction(org.eclipse.core.runtime.IConfigurationElement conf)
conf
- the configuration elementpublic CellExplanation getExplanation()
Function
getExplanation
in interface Function
null
if none is available
for this functionFunction.getExplanation()
public boolean isAugmentation()
public final String getId()
getId
in interface de.cs3d.util.eclipse.extension.simple.IdentifiableExtension.Identifiable
IdentifiableExtension.Identifiable.getId()
public String getDefiningBundle()
Function
getDefiningBundle
in interface Function
Function.getDefiningBundle()
public final String getDisplayName()
Function
getDisplayName
in interface Function
Function.getDisplayName()
public final String getDescription()
Function
getDescription
in interface Function
null
Function.getDescription()
public final String getCategoryId()
Function
getCategoryId
in interface Function
null
Function.getCategoryId()
public final Collection<FunctionParameter> getDefinedParameters()
Function
getDefinedParameters
in interface Function
Function.getDefinedParameters()
public FunctionParameter getParameter(String paramName)
paramName
- the parameter namenull
if it doesn't existpublic URL getIconURL()
Function
getIconURL
in interface Function
null
Function.getIconURL()
public URL getHelpURL()
Function
getHelpURL
in interface Function
null
Function.getHelpURL()
public int hashCode()
hashCode
in class Object
Object.hashCode()
public boolean equals(Object obj)
equals
in class Object
Object.equals(Object)
Build 2013-10-07_11-27-38
Revision 99b27713a799a59a21b0b166eaaea8aaefbf125a