class BinaryMethod extends BinaryMember implements IMethod
IMethod| Modifier and Type | Field and Description |
|---|---|
protected String[] |
exceptionTypes |
protected String[] |
parameterNames
The parameter names for the method.
|
protected String[] |
parameterTypes
The parameter type signatures of the method - stored locally
to perform equality test.
|
protected String |
returnType |
nameoccurrenceCountJEM_ANNOTATION, JEM_CLASSFILE, JEM_COMPILATIONUNIT, JEM_COUNT, JEM_ESCAPE, JEM_FIELD, JEM_IMPORTDECLARATION, JEM_INITIALIZER, JEM_JAVAPROJECT, JEM_LOCALVARIABLE, JEM_METHOD, JEM_PACKAGEDECLARATION, JEM_PACKAGEFRAGMENT, JEM_PACKAGEFRAGMENTROOT, JEM_TYPE, JEM_TYPE_PARAMETER, NO_ELEMENTS, NO_INFO, parentANNOTATION, CLASS_FILE, COMPILATION_UNIT, FIELD, IMPORT_CONTAINER, IMPORT_DECLARATION, INITIALIZER, JAVA_MODEL, JAVA_PROJECT, LOCAL_VARIABLE, METHOD, PACKAGE_DECLARATION, PACKAGE_FRAGMENT, PACKAGE_FRAGMENT_ROOT, TYPE, TYPE_PARAMETER| Modifier | Constructor and Description |
|---|---|
protected |
BinaryMethod(JavaElement parent,
String name,
String[] paramTypes) |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object o)
Returns true if this handle represents the same Java element
as the given handle.
|
IAnnotation[] |
getAnnotations()
Returns the annotations for this element.
|
String |
getAttachedJavadoc(IProgressMonitor monitor)
Returns the Javadoc as an html source if this element has an attached javadoc,
null otherwise.
|
IMemberValuePair |
getDefaultValue()
Returns a
member value pair representing the default
value of this method if any, or null if this method's parent is
not an annotation type, or else if this method does not have a default value. |
int |
getElementType()
Returns this element's kind encoded as an integer.
|
String[] |
getExceptionTypes()
Returns the type signatures of the exceptions this method throws,
in the order declared in the source.
|
int |
getFlags()
Returns the modifier flags for this member.
|
protected void |
getHandleMemento(StringBuffer buff) |
protected char |
getHandleMementoDelimiter()
Returns the
char that marks the start of this handles
contribution to a memento. |
String |
getKey(boolean forceOpen) |
int |
getNumberOfParameters()
Returns the number of parameters of this method.
|
String[] |
getParameterNames()
Returns the names of parameters in this method.
|
String[] |
getParameterTypes()
Returns the type signatures for the parameters of this method.
|
String[] |
getRawParameterNames()
Returns the names of parameters in this method.
|
String |
getReturnType()
Returns the type signature of the return value of this method.
|
String |
getSignature()
Returns the signature of this method.
|
ITypeParameter |
getTypeParameter(String typeParameterName)
Returns the type parameter declared in this method with the given name.
|
ITypeParameter[] |
getTypeParameters()
Returns the formal type parameters for this method.
|
String[] |
getTypeParameterSignatures()
Deprecated.
|
int |
hashCode()
Returns the hash code for this Java element.
|
boolean |
isConstructor()
Returns whether this method is a constructor.
|
boolean |
isMainMethod()
Returns whether this method is a main method.
|
boolean |
isResolved()
Returns whether this method represents a resolved method.
|
boolean |
isSimilar(IMethod method)
Returns whether this method is similar to the given method.
|
String |
readableName() |
JavaElement |
resolved(Binding binding) |
protected void |
toStringInfo(int tab,
StringBuffer buffer,
Object info,
boolean showResolvedInfo)
Debugging purposes
|
protected void |
toStringName(StringBuffer buffer)
Debugging purposes
|
protected void |
toStringName(StringBuffer buffer,
int flags) |
copy, getAnnotations, getCategories, getKey, getNameRange, getSourceRange, isBinary, isStructureKnown, move, rename, setContentsgetElementName, getFullyQualifiedName, getFullyQualifiedParameterizedName, getKey, getKey, getKey, getPackageFragment, getTypeQualifiedName, resolveType, resolveTypeareSimilarMethods, convertConstant, findMethods, getClassFile, getDeclaringType, getHandleFromMemento, getJavadocRange, getOuterMostLocalContext, getType, getTypeRoot, isMainMethod, isReadOnlyclosing, createElementInfo, delete, findNode, generateInfos, getAnnotation, getCompilationUnit, getCorrespondingResource, getHandleUpdatingCountFromMemento, getOccurrenceCount, getOpenableParent, getPath, getSource, getUnderlyingResource, hasChildren, resourceclose, escapeMementoName, exists, getAncestor, getChildren, getChildrenOfType, getElementInfo, getElementInfo, getHandleFromMemento, getHandleIdentifier, getHandleMemento, getIndexOf, getJavadocBaseLocation, getJavaModel, getJavaProject, getLibraryJavadocLocation, getOpenable, getParent, getPrimaryElement, getPrimaryElement, getResource, getSchedulingRule, getSourceElementAt, getSourceMapper, getURLContents, isAncestorOf, newDoesNotExistStatus, newJavaModelException, newNotPresentException, openWhenClosed, tabString, toDebugString, toString, toString, toStringAncestors, toStringChildren, toStringInfo, toStringWithAncestors, toStringWithAncestors, unresolvedgetAdapterclone, finalize, getClass, notify, notifyAll, wait, wait, waitgetElementName, getKeygetCategories, getClassFile, getCompilationUnit, getDeclaringType, getJavadocRange, getNameRange, getOccurrenceCount, getType, getTypeRoot, isBinaryexists, getAncestor, getCorrespondingResource, getHandleIdentifier, getJavaModel, getJavaProject, getOpenable, getParent, getPath, getPrimaryElement, getResource, getSchedulingRule, getUnderlyingResource, isReadOnly, isStructureKnowngetAdapterexists, getSource, getSourceRangecopy, delete, move, renamegetChildren, hasChildrengetAnnotationprotected String[] parameterTypes
null indicates no
parameters.protected String[] parameterNames
protected String[] exceptionTypes
protected String returnType
protected BinaryMethod(JavaElement parent, String name, String[] paramTypes)
public boolean equals(Object o)
JavaElementIf a subclass has other requirements for equality, this method must be overridden.
equals in class SourceRefElementObject.equals(java.lang.Object)public IAnnotation[] getAnnotations() throws JavaModelException
IAnnotatablegetAnnotations in interface IAnnotatablegetAnnotations in class SourceRefElementJavaModelException - if this element does not exist or if an
exception occurs while accessing its corresponding resource.public IMemberValuePair getDefaultValue() throws JavaModelException
IMethodmember value pair representing the default
value of this method if any, or null if this method's parent is
not an annotation type, or else if this method does not have a default value.
Note that IMemberValuePair.getValue() might return null.
Please see this method for more details.
getDefaultValue in interface IMethodnull if noneJavaModelException - if this element does not exist or if an
exception occurs while accessing its corresponding resource.public String[] getExceptionTypes() throws JavaModelException
IMethod
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.
getExceptionTypes in interface IMethodJavaModelException - if this element does not exist or if an
exception occurs while accessing its corresponding resource.Signaturepublic int getElementType()
IJavaElementgetElementType in interface IJavaElementIJavaElementIJavaElementpublic int getFlags() throws JavaModelException
IMemberFlags.
Note that only flags as indicated in the source are returned. Thus if an interface
defines a method void myMethod(); the flags don't include the
'public' flag.
protected void getHandleMemento(StringBuffer buff)
getHandleMemento in class SourceRefElementprotected char getHandleMementoDelimiter()
JavaElementchar that marks the start of this handles
contribution to a memento.getHandleMementoDelimiter in class MemberJavaElement.getHandleMemento()public String getKey(boolean forceOpen) throws JavaModelException
getKey in class BinaryMemberJavaModelExceptionBinding.computeUniqueKey()public int getNumberOfParameters()
IMethodgetNumberOfParameters in interface IMethodpublic String[] getParameterNames() throws JavaModelException
IMethodFor example, a method declared as public void foo(String text, int length)
would return the array {"text","length"}.
getParameterNames in interface IMethodJavaModelException - if this element does not exist or if an
exception occurs while accessing its corresponding resource.public String[] getParameterTypes()
IMethod
For example, a source method declared as public void foo(String text, int length)
would return the array {"QString;","I"}.
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.
getParameterTypes in interface IMethodSignaturepublic ITypeParameter getTypeParameter(String typeParameterName)
IMethodgetTypeParameter in interface IMethodtypeParameterName - the given simple namepublic ITypeParameter[] getTypeParameters() throws JavaModelException
IMethodgetTypeParameters in interface IMethodgetTypeParameters in class NamedMemberJavaModelException - if this element does not exist or if an
exception occurs while accessing its corresponding resource.public String[] getTypeParameterSignatures() throws JavaModelException
IMethod
The formal type parameter signatures may be either unresolved (for source
types) or resolved (for binary types). See Signature for details.
getTypeParameterSignatures in interface IMethodJavaModelException - if this element does not exist or if an
exception occurs while accessing its corresponding resource.IMethod.getTypeParameterSignatures()public String[] getRawParameterNames() throws JavaModelException
IMethodFor example, a method declared as public void foo(String text, int length)
would return the array {"text","length"}. For the same method in a
binary, this would return {"arg0", "arg1"}.
getRawParameterNames in interface IMethodJavaModelException - if this element does not exist or if an
exception occurs while accessing its corresponding resource.public String getReturnType() throws JavaModelException
IMethod
For example, a source method declared as public String getName()
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.
getReturnType in interface IMethodJavaModelException - if this element does not exist or if an
exception occurs while accessing its corresponding resource.Signaturepublic String getSignature() throws JavaModelException
IMethod
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.
getSignature in interface IMethodJavaModelException - if this element does not exist or if an
exception occurs while accessing its corresponding resource.Signaturepublic int hashCode()
JavaElementhashCode in class JavaElementJavaElement.hashCode()public boolean isConstructor() throws JavaModelException
IMethodisConstructor in interface IMethodJavaModelException - if this element does not exist or if an
exception occurs while accessing its corresponding resource.public boolean isMainMethod() throws JavaModelException
IMethod"main"voidstatic and publicString[]isMainMethod in interface IMethodJavaModelException - if this element does not exist or if an
exception occurs while accessing its corresponding resource.public boolean isResolved()
IMethodisResolved in interface IMethodpublic boolean isSimilar(IMethod method)
IMethodisSimilar in interface IMethodmethod - the given methodSignature.getSimpleName(char[])public String readableName()
readableName in class Memberpublic JavaElement resolved(Binding binding)
resolved in class JavaElementprotected void toStringInfo(int tab, StringBuffer buffer, Object info, boolean showResolvedInfo)
JavaElementtoStringInfo in class JavaElementshowResolvedInfo - TODOprotected void toStringName(StringBuffer buffer)
JavaElementtoStringName in class SourceRefElementprotected void toStringName(StringBuffer buffer, int flags)
public String getAttachedJavadoc(IProgressMonitor monitor) throws JavaModelException
IJavaElementReturns the Javadoc as an html source if this element has an attached javadoc, null otherwise.
This should be used only for binary elements. Source elements will always return null.
The encoding used to read the javadoc is the one defined by the content type of the file. If none is defined, then the project's encoding of this java element is used. If the project's encoding cannot be retrieved, then the platform encoding is used.
In case of the javadoc doesn't exist for this element, null is returned.
The html is extracted from the attached javadoc and provided as is. No transformation or validation is done.
getAttachedJavadoc in interface IJavaElementgetAttachedJavadoc in class JavaElementmonitor - the given progress monitorJavaModelException - if:IClasspathAttribute.JAVADOC_LOCATION_ATTRIBUTE_NAME