public class Operator extends PropertyAwareObject implements IOperator
| Modifier and Type | Field and Description |
|---|---|
static String |
DOCUMENTATION_CHANGED
Event - documentation changed.
|
static String |
IMPLEMENTATION_DETAILS_CHANGED
Event - implementation detail list changed.
|
static String |
NAME_CHANGED
Event - name changed.
|
static String |
PARAMETERS_CHANGED
Event - parameter list changed.
|
static String |
PURPOSE_CHANGED
Event - purpose attribute changed.
|
static String |
RETURN_TYPE_CHANGED
Event - return type changed.
|
static String |
RETURN_TYPE_NAME_CHANGED
Event - return type name changed.
|
listeners| Constructor and Description |
|---|
Operator() |
| Modifier and Type | Method and Description |
|---|---|
void |
addImplementationDetail(IImplementationDetail detail) |
void |
addParameter(IParameter param)
Add a parameter to the end of the list.
|
void |
addParameter(IParameter param,
IParameter before)
Add a parameter before another one.
|
void |
clearImplementationDetail(String label) |
void |
clearParameters() |
String |
getDocumentation()
Get the documentation string attached to this operator, if any.
|
String |
getImplementationDetail(String label)
Get an implementation detail associated with the operator, given its label.
|
Collection<IImplementationDetail> |
getImplementationDetails()
Return all implementation details associated with the operator.
|
String |
getName()
Return the operator name.
|
NRLDataType |
getNRLReturnType()
Returns the return type of the operator.
|
IParameter |
getParameter(String name)
Return a parameter by name
|
List<IParameter> |
getParameters()
Return a list of
IParameter objects. |
String |
getPurpose()
Return the purpose of this operator.
|
IModelElement |
getReturnType()
Return the return type of the operator.
|
String |
getReturnTypeName()
Return the name of the return type as found in the definition
|
void |
removeParameter(IParameter param) |
List<NRLError> |
resolveModelReferences(IModelCollection models)
Resolve all parameter type and return type references against models.
|
void |
setDocumentation(String documentation) |
void |
setName(String name) |
void |
setNRLReturnType(NRLDataType returnType)
Set the NRL type of the return type
|
void |
setPurpose(String purpose) |
void |
setReturnType(IModelElement returnType)
Set the type this operator will return.
|
void |
setReturnTypeName(String returnTypeName)
Set the raw name of the return type.
|
addPropertyChangeListener, firePropertyChange, removePropertyChangeListenerpublic static final String DOCUMENTATION_CHANGED
public static final String NAME_CHANGED
public static final String IMPLEMENTATION_DETAILS_CHANGED
public static final String PARAMETERS_CHANGED
public static final String PURPOSE_CHANGED
public static final String RETURN_TYPE_CHANGED
public static final String RETURN_TYPE_NAME_CHANGED
public void addImplementationDetail(IImplementationDetail detail)
public void addParameter(IParameter param)
param - the parameter to addpublic void addParameter(IParameter param, IParameter before)
param - the parameter to addbefore - the parameter before which to insert. If this is null, or the before
parameter is not in the list, "param" is inserted at the front.public void clearImplementationDetail(String label)
public void clearParameters()
public String getDocumentation()
IOperatorgetDocumentation in interface IOperatorpublic String getImplementationDetail(String label)
IOperator
See IImplementationDetail for more information.
getImplementationDetail in interface IOperatorlabel - the labelpublic Collection<IImplementationDetail> getImplementationDetails()
IOperatorIImplementationDetail for more information.
Note that this does not return the implementation details associated with parameters of the operators - those have to be read off the individual parameters.
getImplementationDetails in interface IOperatorIImplementationDetail objectspublic String getName()
IOperatorpublic NRLDataType getNRLReturnType()
IOperatorNRLDataType.UNKNOWN.getNRLReturnType in interface IOperatorpublic IParameter getParameter(String name)
IOperatorgetParameter in interface IOperatorname - parameter namepublic List<IParameter> getParameters()
IOperatorIParameter objects.getParameters in interface IOperatorpublic String getPurpose()
IOperatorgetPurpose in interface IOperatorpublic IModelElement getReturnType()
IOperatorIOperator.resolveModelReferences(IModelCollection) before this.getReturnType in interface IOperatorpublic String getReturnTypeName()
IOperatorgetReturnTypeName in interface IOperatorpublic void removeParameter(IParameter param)
public List<NRLError> resolveModelReferences(IModelCollection models)
IOperatorresolveModelReferences in interface IOperatormodels - the modelspublic void setDocumentation(String documentation)
public void setName(String name)
public void setNRLReturnType(NRLDataType returnType)
IOperatorsetNRLReturnType in interface IOperatorreturnType - the typepublic void setPurpose(String purpose)
public void setReturnType(IModelElement returnType)
IOperatorsetReturnType in interface IOperatorreturnType - the typepublic void setReturnTypeName(String returnTypeName)
IOperatorsetReturnTypeName in interface IOperatorreturnTypeName - the nameCopyright © 2006-2013. All Rights Reserved.