|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IFunction
Represents a function or a method (or constructor) declared in a type.
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.
Field Summary |
---|
Fields inherited from interface org.eclipse.wst.jsdt.core.IJavaScriptElement |
---|
CLASS_FILE, FIELD, IMPORT_CONTAINER, IMPORT_DECLARATION, INITIALIZER, JAVASCRIPT_MODEL, JAVASCRIPT_PROJECT, JAVASCRIPT_UNIT, LOCAL_VARIABLE, METHOD, PACKAGE_DECLARATION, PACKAGE_FRAGMENT, PACKAGE_FRAGMENT_ROOT, TYPE, TYPE_PARAMETER |
Method Summary | |
---|---|
java.lang.String |
getElementName()
Returns the simple name of this function or method. |
java.lang.String[] |
getExceptionTypes()
Returns the type signatures of the exceptions this method throws, in the order declared in the source. |
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. |
ITypeParameter |
getTypeParameter(java.lang.String name)
Returns the type parameter declared in this method with the given name. |
ITypeParameter[] |
getTypeParameters()
Returns the formal type parameters for this method. |
boolean |
isConstructor()
Returns whether this method is a constructor. |
boolean |
isMainMethod()
|
boolean |
isResolved()
Returns whether this method represents a resolved method. |
boolean |
isSimilar(IFunction method)
Returns whether this method is similar to the given method. |
Methods inherited from interface org.eclipse.wst.jsdt.core.IMember |
---|
getCategories, getClassFile, getCompilationUnit, getDeclaringType, getFlags, getJavaScriptUnit, getJSdocRange, getNameRange, getOccurrenceCount, getType, getTypeRoot, isBinary |
Methods inherited from interface org.eclipse.wst.jsdt.core.IJavaScriptElement |
---|
exists, getAncestor, getAttachedJavadoc, getCommonSuperType, getCorrespondingResource, getDisplayName, getElementType, getHandleIdentifier, getHostPath, getJavaScriptModel, getJavaScriptProject, getOpenable, getParent, getPath, getPrimaryElement, getResource, getSchedulingRule, getUnderlyingResource, isReadOnly, isStructureKnown, isVirtual |
Methods inherited from interface org.eclipse.wst.jsdt.core.ILookupScope |
---|
newNameLookup, newNameLookup, newSearchableNameEnvironment, newSearchableNameEnvironment |
Methods inherited from interface org.eclipse.wst.jsdt.core.ISourceReference |
---|
exists, getSource, getSourceRange |
Methods inherited from interface org.eclipse.wst.jsdt.core.ISourceManipulation |
---|
copy, delete, move, rename |
Methods inherited from interface org.eclipse.wst.jsdt.core.IParent |
---|
getChildren, hasChildren |
Method Detail |
---|
java.lang.String getElementName()
getElementName
in interface IJavaScriptElement
java.lang.String[] getExceptionTypes() throws JavaScriptModelException
For example, a source method declaring "throws IOException"
,
would return the array {"QIOException;"}
.
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.
Note: This Method only applies to ECMAScript 4 which is not yet supported
JavaScriptModelException
- if this element does not exist or if an
exception occurs while accessing its corresponding resource.Signature
ITypeParameter[] getTypeParameters() throws JavaScriptModelException
Note: This Method only applies to ECMAScript 4 which is not yet supported
JavaScriptModelException
- if this element does not exist or if an
exception occurs while accessing its corresponding resource.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
ITypeParameter getTypeParameter(java.lang.String name)
Note: This Method only applies to ECMAScript 4 which is not yet supported
name
- the given simple name
boolean isConstructor() throws JavaScriptModelException
JavaScriptModelException
- if this element does not exist or if an
exception occurs while accessing its corresponding resource.boolean isMainMethod() throws JavaScriptModelException
JavaScriptModelException
boolean isResolved()
boolean isSimilar(IFunction method)
method
- the given method
Signature.getSimpleName(char[])
IFunction getFunction(java.lang.String selector, java.lang.String[] parameterTypeSignatures)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |