public interface IFunction extends IMember
This interface is not intended to be implemented by clients.
Provisional API: This class/interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.CLASS_FILE, EXPORT_CONTAINER, EXPORT_DECLARATION, FIELD, IMPORT_CONTAINER, IMPORT_DECLARATION, INITIALIZER, JAVASCRIPT_MODEL, JAVASCRIPT_PROJECT, JAVASCRIPT_UNIT, LOCAL_VARIABLE, METHOD, PACKAGE_FRAGMENT, PACKAGE_FRAGMENT_ROOT, TYPE
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getElementName()
Returns the simple name of this function or method.
|
IFunction |
getFunction(java.lang.String selector,
java.lang.String[] parameterTypeSignatures) |
java.lang.String |
getKey()
Returns the binding key for this method.
|
int |
getNumberOfParameters()
Returns the number of parameters of this method.
|
java.lang.String[] |
getParameterNames()
Returns the names of parameters in this method.
|
java.lang.String[] |
getParameterTypes()
Returns the type signatures for the parameters of this method.
|
java.lang.String[] |
getRawParameterNames()
Returns the names of parameters in this method.
|
java.lang.String |
getReturnType()
Returns the type signature of the return value of this method.
|
java.lang.String |
getSignature()
Returns the signature of this method.
|
boolean |
isConstructor()
Returns whether this method is a constructor.
|
boolean |
isResolved()
Returns whether this method represents a resolved method.
|
boolean |
isSimilar(IFunction method)
Returns whether this method is similar to the given method.
|
getCategories, getClassFile, getDeclaringType, getFlags, getJavaScriptUnit, getJSdocRange, getNameRange, getOccurrenceCount, getType, getTypeRoot, isBinary
exists, getAncestor, getAttachedJavadoc, getCommonSuperType, getCorrespondingResource, getDisplayName, getElementType, getHandleIdentifier, getHostPath, getJavaScriptModel, getJavaScriptProject, getOpenable, getParent, getPath, getPrimaryElement, getResource, getSchedulingRule, getUnderlyingResource, isReadOnly, isStructureKnown, isVirtual
newNameLookup, newNameLookup, newSearchableNameEnvironment, newSearchableNameEnvironment
exists, getSource, getSourceRange
copy, delete, move, rename
getChildren, hasChildren
java.lang.String getElementName()
getElementName
in interface IJavaScriptElement
int getNumberOfParameters()
java.lang.String getKey()
IBinding.getKey()
,
BindingKey
java.lang.String[] getParameterNames() throws JavaScriptModelException
For example, a method declared as function foo( text, length)
would return the array {"text","length"}
.
JavaScriptModelException
- if this element does not exist or if an
exception occurs while accessing its corresponding resource.java.lang.String[] getParameterTypes()
The type signatures may be either unresolved (for source types)
or resolved (for binary types), and either basic (for basic types)
or rich (for parameterized types). See Signature
for details.
Signature
java.lang.String[] getRawParameterNames() throws JavaScriptModelException
For example, a method declared as function foo( text, length)
would return the array {"text","length"}
. For the same method in a
binary, this would return {"arg0", "arg1"}
.
JavaScriptModelException
- if this element does not exist or if an
exception occurs while accessing its corresponding resource.java.lang.String getReturnType() throws JavaScriptModelException
Until EMCAScript 4 is supported, types are inferred by analying the code, and are not necessarily accurate.
For example, a source method declared as function getName(){return "abc"}
would return "QString;"
.
The type signature may be either unresolved (for source types)
or resolved (for binary types), and either basic (for basic types)
or rich (for parameterized types). See Signature
for details.
JavaScriptModelException
- if this element does not exist or if an
exception occurs while accessing its corresponding resource.Signature
java.lang.String getSignature() throws JavaScriptModelException
For example, a source method declared as public void foo(String text, int length)
would return "(QString;I)V"
.
The type signatures embedded in the method signature may be either unresolved
(for source types) or resolved (for binary types), and either basic (for
basic types) or rich (for parameterized types). See Signature
for
details.
JavaScriptModelException
- if this element does not exist or if an
exception occurs while accessing its corresponding resource.Signature
boolean isConstructor() throws JavaScriptModelException
JavaScriptModelException
- if this element does not exist or if an
exception occurs while accessing its corresponding resource.boolean isResolved()
boolean isSimilar(IFunction method)
method
- the given methodSignature.getSimpleName(char[])
IFunction getFunction(java.lang.String selector, java.lang.String[] parameterTypeSignatures)
Copyright (c) IBM Corp. and others 2000, 2010. All Rights Reserved.