Package org.aspectj.org.eclipse.jdt.internal.core

Class SourceMethod

java.lang.Object
org.eclipse.core.runtime.PlatformObject
org.aspectj.org.eclipse.jdt.internal.core.JavaElement
org.aspectj.org.eclipse.jdt.internal.core.SourceRefElement
org.aspectj.org.eclipse.jdt.internal.core.Member
org.aspectj.org.eclipse.jdt.internal.core.NamedMember
org.aspectj.org.eclipse.jdt.internal.core.SourceMethod
All Implemented Interfaces:
IAnnotatable, IJavaElement, IMember, IMethod, IParent, ISourceManipulation, ISourceReference, org.eclipse.core.runtime.IAdaptable
Direct Known Subclasses:
LambdaMethod, ResolvedSourceMethod
public class SourceMethod extends NamedMember implements IMethod
See Also:
IMethod

  • Field Details

    • parameterTypes

      protected String[] parameterTypes
      The parameter type signatures of the method - stored locally to perform equality test. null indicates no parameters.

  • Constructor Details

  • Method Details

    • closing

      protected void closing​(Object info) throws JavaModelException
      Description copied from class: SourceRefElement
      This element is being closed. Do any necessary cleanup.
      Overrides:
      closing in class SourceRefElement
      Throws:
      JavaModelException

    • equals

      public boolean equals​(Object o)
      Description copied from class: JavaElement
      Returns true if this handle represents the same Java element as the given handle. By default, two handles represent the same element if they are identical or if they represent the same type of element, have equal names, parents, and occurrence counts.

      If a subclass has other requirements for equality, this method must be overridden.

      Overrides:
      equals in class SourceRefElement
      See Also:
      Object.equals(java.lang.Object)

    • getDefaultValue

      public IMemberValuePair getDefaultValue() throws JavaModelException
      Description copied from interface: IMethod
      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.

      Note that IMemberValuePair.getValue() might return null. Please see this method for more details.

      Specified by:
      getDefaultValue in interface IMethod
      Returns:
      a member pair value if any, or null if none
      Throws:
      JavaModelException - if this element does not exist or if an exception occurs while accessing its corresponding resource.

    • getElementType

      public int getElementType()
      Description copied from interface: IJavaElement
      Returns this element's kind encoded as an integer. This is a handle-only method.
      Specified by:
      getElementType in interface IJavaElement
      Returns:
      the kind of element; one of the constants declared in IJavaElement
      See Also:
      IJavaElement

    • getExceptionTypes

      public String[] getExceptionTypes() throws JavaModelException
      Description copied from interface: IMethod
      Returns the type signatures of the exceptions this method throws, in the order declared in the source. Returns an empty array if this method throws no exceptions.

      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.

      Specified by:
      getExceptionTypes in interface IMethod
      Returns:
      the type signatures of the exceptions this method throws, in the order declared in the source, an empty array if this method throws no exceptions
      Throws:
      JavaModelException - if this element does not exist or if an exception occurs while accessing its corresponding resource.
      See Also:
      IMethod

    • getHandleMemento

      protected void getHandleMemento​(StringBuffer buff)
      Overrides:
      getHandleMemento in class SourceRefElement
      See Also:
      JavaElement.getHandleMemento(StringBuffer)

    • getHandleMementoDelimiter

      protected char getHandleMementoDelimiter()
      Description copied from class: JavaElement
      Returns the char that marks the start of this handles contribution to a memento.
      Overrides:
      getHandleMementoDelimiter in class Member
      See Also:
      JavaElement.getHandleMemento()

    • getKey

      public String getKey()
      Description copied from interface: IMethod
      Returns the binding key for this method only if the given method is resolved. A binding key is a key that uniquely identifies this method. It allows access to:
      • generic info for parameterized methods
      • the actual return type for references to Object.getClass()
      • the actual parameter types and return type for references to signature polymorphic methods from class MethodHandle

      If the given method is not resolved, the returned key is simply the java element's key.

      Specified by:
      getKey in interface IMethod
      Returns:
      the binding key for this method
      See Also:
      IBinding.getKey(), BindingKey, IMethod.isResolved()

    • getNumberOfParameters

      public int getNumberOfParameters()
      Description copied from interface: IMethod
      Returns the number of parameters of this method. This is a handle-only method.
      Specified by:
      getNumberOfParameters in interface IMethod
      Returns:
      the number of parameters of this method
      See Also:
      IMethod

    • getParameterNames

      public String[] getParameterNames() throws JavaModelException
      Description copied from interface: IMethod
      Returns the names of parameters in this method. For binary types, associated source or attached Javadoc are used to retrieve the names. If none can be retrieved, then these names are invented as "arg"+i, where i starts at 0. Returns an empty array if this method has no parameters.

      For example, a method declared as public void foo(String text, int length) would return the array {"text","length"}.

      Specified by:
      getParameterNames in interface IMethod
      Returns:
      the names of parameters in this method, an empty array if this method has no parameters
      Throws:
      JavaModelException - if this element does not exist or if an exception occurs while accessing its corresponding resource.
      See Also:
      IMethod

    • getParameterTypes

      public String[] getParameterTypes()
      Description copied from interface: IMethod
      Returns the type signatures for the parameters of this method. Returns an empty array if this method has no parameters. This is a handle-only method.

      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.

      Specified by:
      getParameterTypes in interface IMethod
      Returns:
      the type signatures for the parameters of this method, an empty array if this method has no parameters
      See Also:
      IMethod

    • getTypeParameter

      public ITypeParameter getTypeParameter​(String typeParameterName)
      Description copied from interface: IMethod
      Returns the type parameter declared in this method with the given name. This is a handle-only method. The type parameter may or may not exist.
      Specified by:
      getTypeParameter in interface IMethod
      Parameters:
      typeParameterName - the given simple name
      Returns:
      the type parameter declared in this method with the given name

    • getTypeParameters

      public ITypeParameter[] getTypeParameters() throws JavaModelException
      Description copied from interface: IMethod
      Returns the formal type parameters for this method. Returns an empty array if this method has no formal type parameters.
      Specified by:
      getTypeParameters in interface IMethod
      Overrides:
      getTypeParameters in class NamedMember
      Returns:
      the formal type parameters of this method, in the order declared in the source, an empty array if none
      Throws:
      JavaModelException - if this element does not exist or if an exception occurs while accessing its corresponding resource.

    • getParameters

      public ILocalVariable[] getParameters() throws JavaModelException
      Description copied from interface: IMethod
      Returns the parameters of this method.

      An empty array is returned, if the method has no parameters.

      For binary types, associated source is used to retrieve the name range, source range and the flags.

      These local variables can be used to retrieve the parameter annotations.

      Specified by:
      getParameters in interface IMethod
      Returns:
      the parameters of this method
      Throws:
      JavaModelException - if this element does not exist or if an exception occurs while accessing its corresponding resource.

    • getTypeParameterSignatures

      public String[] getTypeParameterSignatures() throws JavaModelException
      Deprecated.
      Description copied from interface: IMethod
      Returns the formal type parameter signatures for this method. Returns an empty array if this method has no formal type parameters.

      The formal type parameter signatures may be either unresolved (for source types) or resolved (for binary types). See Signature for details.

      Specified by:
      getTypeParameterSignatures in interface IMethod
      Returns:
      the formal type parameter signatures of this method, in the order declared in the source, an empty array if none
      Throws:
      JavaModelException - if this element does not exist or if an exception occurs while accessing its corresponding resource.
      Since:
      3.0
      See Also:
      IMethod.getTypeParameterSignatures()

    • getPrimaryElement

      public IJavaElement getPrimaryElement​(boolean checkOwner)
      Overrides:
      getPrimaryElement in class JavaElement

    • getRawParameterNames

      public String[] getRawParameterNames() throws JavaModelException
      Description copied from interface: IMethod
      Returns the names of parameters in this method. For binary types, these names are invented as "arg"+i, where i starts at 0 (even if source is associated with the binary or if Javdoc is attached to the binary). Returns an empty array if this method has no parameters.

      For 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"}.

      Specified by:
      getRawParameterNames in interface IMethod
      Returns:
      the names of parameters in this method, an empty array if this method has no parameters
      Throws:
      JavaModelException - if this element does not exist or if an exception occurs while accessing its corresponding resource.

    • getReturnType

      public String getReturnType() throws JavaModelException
      Description copied from interface: IMethod
      Returns the type signature of the return value of this method. For constructors, this returns the signature for void.

      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.

      Specified by:
      getReturnType in interface IMethod
      Returns:
      the type signature of the return value of this method, void for constructors
      Throws:
      JavaModelException - if this element does not exist or if an exception occurs while accessing its corresponding resource.
      See Also:
      IMethod

    • getSignature

      public String getSignature() throws JavaModelException
      Description copied from interface: IMethod
      Returns the signature of this method. This includes the signatures for the parameter types and return type, but does not include the method name, exception types, or type parameters.

      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.

      Specified by:
      getSignature in interface IMethod
      Returns:
      the signature of this method
      Throws:
      JavaModelException - if this element does not exist or if an exception occurs while accessing its corresponding resource.
      See Also:
      IMethod

    • hashCode

      public int hashCode()
      Description copied from class: JavaElement
      Returns the hash code for this Java element. By default, the hash code for an element is a combination of its name and parent's hash code. Elements with other requirements must override this method.
      Overrides:
      hashCode in class JavaElement
      See Also:
      JavaElement.hashCode()

    • isConstructor

      public boolean isConstructor() throws JavaModelException
      Description copied from interface: IMethod
      Returns whether this method is a constructor.
      Specified by:
      isConstructor in interface IMethod
      Returns:
      true if this method is a constructor, false otherwise
      Throws:
      JavaModelException - if this element does not exist or if an exception occurs while accessing its corresponding resource.
      See Also:
      IMethod

    • isMainMethod

      public boolean isMainMethod() throws JavaModelException
      Description copied from interface: IMethod
      Returns whether this method is a main method. It is a main method if:
      • its name is equal to "main"
      • its return type is void
      • it is static and public
      • it defines one parameter whose type's simple name is String[]
      Specified by:
      isMainMethod in interface IMethod
      Returns:
      true if this method is a main method, false otherwise
      Throws:
      JavaModelException - if this element does not exist or if an exception occurs while accessing its corresponding resource.
      See Also:
      IMethod.isMainMethod()

    • isLambdaMethod

      public boolean isLambdaMethod()
      Description copied from interface: IMethod
      Returns whether this method represents a lambda expression.
      Specified by:
      isLambdaMethod in interface IMethod
      Returns:
      true if this method represents a lambda expression, false otherwise.
      See Also:
      IMethod.isLambdaMethod()

    • isResolved

      public boolean isResolved()
      Description copied from interface: IMethod
      Returns whether this method represents a resolved method. If a method is resolved, its key contains resolved information.
      Specified by:
      isResolved in interface IMethod
      Returns:
      whether this method represents a resolved method.

    • isSimilar

      public boolean isSimilar​(IMethod method)
      Description copied from interface: IMethod
      Returns whether this method is similar to the given method. Two methods are similar if:
      • their element names are equal
      • they have the same number of parameters
      • the simple names of their parameter types are equal
      This is a handle-only method.
      Specified by:
      isSimilar in interface IMethod
      Parameters:
      method - the given method
      Returns:
      true if this method is similar to the given method.
      See Also:
      IMethod.isSimilar(IMethod)

    • readableName

      public String readableName()
      Overrides:
      readableName in class Member

    • resolved

      public JavaElement resolved​(Binding binding)
      Overrides:
      resolved in class JavaElement

    • toStringInfo

      protected void toStringInfo​(int tab, StringBuffer buffer, Object info, boolean showResolvedInfo)
      Description copied from class: JavaElement
      Debugging purposes
      Overrides:
      toStringInfo in class JavaElement
      showResolvedInfo - TODO

    • toStringName

      protected void toStringName​(StringBuffer buffer)
      Description copied from class: JavaElement
      Debugging purposes
      Overrides:
      toStringName in class SourceRefElement

    • toStringName

      protected void toStringName​(StringBuffer buffer, int flags)