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

Klasse 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
Alle implementierten Schnittstellen:
IAnnotatable, IJavaElement, IMember, IMethod, IParent, ISourceManipulation, ISourceReference, org.eclipse.core.runtime.IAdaptable
Bekannte direkte Unterklassen:
LambdaMethod, ResolvedSourceMethod
public class SourceMethod extends NamedMember implements IMethod
Siehe auch:

  • Felddetails

    • parameterTypes

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

  • Konstruktordetails

  • Methodendetails

    • closing

      protected void closing(Object info) throws JavaModelException
      Beschreibung aus Klasse kopiert: SourceRefElement
      This element is being closed. Do any necessary cleanup.
      Setzt außer Kraft:
      closing in Klasse SourceRefElement
      Löst aus:
      JavaModelException

    • equals

      public boolean equals(Object o)
      Beschreibung aus Klasse kopiert: 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.

      Setzt außer Kraft:
      equals in Klasse SourceRefElement
      Siehe auch:

    • getDefaultValue

      public IMemberValuePair getDefaultValue() throws JavaModelException
      Beschreibung aus Schnittstelle kopiert: 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.

      Angegeben von:
      getDefaultValue in Schnittstelle IMethod
      Gibt zurück:
      a member pair value if any, or null if none
      Löst aus:
      JavaModelException - if this element does not exist or if an exception occurs while accessing its corresponding resource.

    • getElementType

      public int getElementType()
      Beschreibung aus Schnittstelle kopiert: IJavaElement
      Returns this element's kind encoded as an integer. This is a handle-only method.
      Angegeben von:
      getElementType in Schnittstelle IJavaElement
      Gibt zurück:
      the kind of element; one of the constants declared in IJavaElement
      Siehe auch:

    • getExceptionTypes

      public String[] getExceptionTypes() throws JavaModelException
      Beschreibung aus Schnittstelle kopiert: 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.

      Angegeben von:
      getExceptionTypes in Schnittstelle IMethod
      Gibt zurück:
      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
      Löst aus:
      JavaModelException - if this element does not exist or if an exception occurs while accessing its corresponding resource.
      Siehe auch:

    • getHandleMemento

      protected void getHandleMemento(StringBuilder buff)
      Setzt außer Kraft:
      getHandleMemento in Klasse SourceRefElement
      Siehe auch:

    • getHandleMementoDelimiter

      protected char getHandleMementoDelimiter()
      Beschreibung aus Klasse kopiert: JavaElement
      Returns the char that marks the start of this handles contribution to a memento.
      Setzt außer Kraft:
      getHandleMementoDelimiter in Klasse Member
      Siehe auch:

    • getKey

      public String getKey()
      Beschreibung aus Schnittstelle kopiert: 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.

      Angegeben von:
      getKey in Schnittstelle IMethod
      Gibt zurück:
      the binding key for this method
      Siehe auch:

    • getNumberOfParameters

      public int getNumberOfParameters()
      Beschreibung aus Schnittstelle kopiert: IMethod
      Returns the number of parameters of this method. This is a handle-only method.
      Angegeben von:
      getNumberOfParameters in Schnittstelle IMethod
      Gibt zurück:
      the number of parameters of this method
      Siehe auch:

    • getParameterNames

      public String[] getParameterNames() throws JavaModelException
      Beschreibung aus Schnittstelle kopiert: 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"}.

      Angegeben von:
      getParameterNames in Schnittstelle IMethod
      Gibt zurück:
      the names of parameters in this method, an empty array if this method has no parameters
      Löst aus:
      JavaModelException - if this element does not exist or if an exception occurs while accessing its corresponding resource.
      Siehe auch:

    • getParameterTypes

      public String[] getParameterTypes()
      Beschreibung aus Schnittstelle kopiert: 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.

      Angegeben von:
      getParameterTypes in Schnittstelle IMethod
      Gibt zurück:
      the type signatures for the parameters of this method, an empty array if this method has no parameters
      Siehe auch:

    • getTypeParameter

      public ITypeParameter getTypeParameter(String typeParameterName)
      Beschreibung aus Schnittstelle kopiert: 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.
      Angegeben von:
      getTypeParameter in Schnittstelle IMethod
      Parameter:
      typeParameterName - the given simple name
      Gibt zurück:
      the type parameter declared in this method with the given name

    • getTypeParameters

      public ITypeParameter[] getTypeParameters() throws JavaModelException
      Beschreibung aus Schnittstelle kopiert: IMethod
      Returns the formal type parameters for this method. Returns an empty array if this method has no formal type parameters.
      Angegeben von:
      getTypeParameters in Schnittstelle IMethod
      Setzt außer Kraft:
      getTypeParameters in Klasse NamedMember
      Gibt zurück:
      the formal type parameters of this method, in the order declared in the source, an empty array if none
      Löst aus:
      JavaModelException - if this element does not exist or if an exception occurs while accessing its corresponding resource.

    • getParameters

      public ILocalVariable[] getParameters() throws JavaModelException
      Beschreibung aus Schnittstelle kopiert: 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.

      Angegeben von:
      getParameters in Schnittstelle IMethod
      Gibt zurück:
      the parameters of this method
      Löst aus:
      JavaModelException - if this element does not exist or if an exception occurs while accessing its corresponding resource.

    • getTypeParameterSignatures

      public String[] getTypeParameterSignatures() throws JavaModelException
      Veraltet.
      Beschreibung aus Schnittstelle kopiert: 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.

      Angegeben von:
      getTypeParameterSignatures in Schnittstelle IMethod
      Gibt zurück:
      the formal type parameter signatures of this method, in the order declared in the source, an empty array if none
      Löst aus:
      JavaModelException - if this element does not exist or if an exception occurs while accessing its corresponding resource.
      Seit:
      3.0
      Siehe auch:

    • getPrimaryElement

      public JavaElement getPrimaryElement(boolean checkOwner)
      Setzt außer Kraft:
      getPrimaryElement in Klasse JavaElement

    • getRawParameterNames

      public String[] getRawParameterNames() throws JavaModelException
      Beschreibung aus Schnittstelle kopiert: 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"}.

      Angegeben von:
      getRawParameterNames in Schnittstelle IMethod
      Gibt zurück:
      the names of parameters in this method, an empty array if this method has no parameters
      Löst aus:
      JavaModelException - if this element does not exist or if an exception occurs while accessing its corresponding resource.

    • getReturnType

      public String getReturnType() throws JavaModelException
      Beschreibung aus Schnittstelle kopiert: 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.

      Angegeben von:
      getReturnType in Schnittstelle IMethod
      Gibt zurück:
      the type signature of the return value of this method, void for constructors
      Löst aus:
      JavaModelException - if this element does not exist or if an exception occurs while accessing its corresponding resource.
      Siehe auch:

    • getSignature

      public String getSignature() throws JavaModelException
      Beschreibung aus Schnittstelle kopiert: 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.

      Angegeben von:
      getSignature in Schnittstelle IMethod
      Gibt zurück:
      the signature of this method
      Löst aus:
      JavaModelException - if this element does not exist or if an exception occurs while accessing its corresponding resource.
      Siehe auch:

    • hashCode

      public int hashCode()
      Beschreibung aus Klasse kopiert: 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.
      Setzt außer Kraft:
      hashCode in Klasse JavaElement
      Siehe auch:
      • Ungültige Referenz 
        org.eclipse.jdt.internal.core.JavaElement#hashCode()

    • isConstructor

      public boolean isConstructor() throws JavaModelException
      Beschreibung aus Schnittstelle kopiert: IMethod
      Returns whether this method is a constructor.
      Angegeben von:
      isConstructor in Schnittstelle IMethod
      Gibt zurück:
      true if this method is a constructor, false otherwise
      Löst aus:
      JavaModelException - if this element does not exist or if an exception occurs while accessing its corresponding resource.
      Siehe auch:

    • isMainMethod

      public boolean isMainMethod() throws JavaModelException
      Beschreibung aus Schnittstelle kopiert: 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[]
      Angegeben von:
      isMainMethod in Schnittstelle IMethod
      Gibt zurück:
      true if this method is a main method, false otherwise
      Löst aus:
      JavaModelException - if this element does not exist or if an exception occurs while accessing its corresponding resource.
      Siehe auch:

    • isMainMethodCandidate

      public boolean isMainMethodCandidate() throws JavaModelException
      Beschreibung aus Schnittstelle kopiert: IMethod
      Returns whether this method is a main method candidate. 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[]
      Starting with Java 21 there is "preview feature" that allows instance main methods. It is a main method according to this JEP if:
      • its name is equal to "main"
      • its return type is void
      • it is non-private
      • it defines one parameter whose type's simple name is String[] or no parameter at all
      Angegeben von:
      isMainMethodCandidate in Schnittstelle IMethod
      Gibt zurück:
      true if this method is a main method, false otherwise
      Löst aus:
      JavaModelException - if this element does not exist or if an exception occurs while accessing its corresponding resource.

    • isLambdaMethod

      public boolean isLambdaMethod()
      Beschreibung aus Schnittstelle kopiert: IMethod
      Returns whether this method represents a lambda expression.
      Angegeben von:
      isLambdaMethod in Schnittstelle IMethod
      Gibt zurück:
      true if this method represents a lambda expression, false otherwise.
      Siehe auch:

    • isResolved

      public boolean isResolved()
      Beschreibung aus Schnittstelle kopiert: IMethod
      Returns whether this method represents a resolved method. If a method is resolved, its key contains resolved information.
      Angegeben von:
      isResolved in Schnittstelle IMethod
      Gibt zurück:
      whether this method represents a resolved method.

    • isSimilar

      public boolean isSimilar(IMethod method)
      Beschreibung aus Schnittstelle kopiert: 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.
      Angegeben von:
      isSimilar in Schnittstelle IMethod
      Parameter:
      method - the given method
      Gibt zurück:
      true if this method is similar to the given method.
      Siehe auch:

    • readableName

      public String readableName()
      Setzt außer Kraft:
      readableName in Klasse Member

    • resolved

      public JavaElement resolved(Binding binding)
      Setzt außer Kraft:
      resolved in Klasse JavaElement

    • toStringInfo

      protected void toStringInfo(int tab, StringBuilder buffer, Object info, boolean showResolvedInfo)
      Beschreibung aus Klasse kopiert: JavaElement
      Debugging purposes
      Setzt außer Kraft:
      toStringInfo in Klasse JavaElement
      Parameter:
      showResolvedInfo - TODO

    • toStringName

      protected void toStringName(StringBuilder buffer)
      Beschreibung aus Klasse kopiert: JavaElement
      Debugging purposes
      Setzt außer Kraft:
      toStringName in Klasse SourceRefElement

    • toStringName

      protected void toStringName(StringBuilder buffer, int flags)