Klasse BinaryMethod

Alle implementierten Schnittstellen:
IAnnotatable, IJavaElement, IMember, IMethod, IParent, ISourceManipulation, ISourceReference, org.eclipse.core.runtime.IAdaptable
Bekannte direkte Unterklassen:
ResolvedBinaryMethod

public class BinaryMethod extends BinaryMember implements IMethod
Siehe auch:
  • Felddetails

    • parameterTypes

      protected String[] parameterTypes
      The parameter type signatures of the method - stored locally to perform equality test. CharOperation.NO_STRINGS indicates no parameters. Note that the parameter type signatures are expected to be dot-based.
    • erasedParamaterTypes

      protected String[] erasedParamaterTypes
    • parameterNames

      protected String[] parameterNames
      The parameter names for the method.
    • exceptionTypes

      protected String[] exceptionTypes
    • returnType

      protected String returnType
  • Konstruktordetails

  • Methodendetails

    • 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:
    • getAnnotations

      public IAnnotation[] getAnnotations() throws JavaModelException
      Beschreibung aus Schnittstelle kopiert: IAnnotatable
      Returns the annotations for this element. Returns an empty array if this element has no annotations.
      Angegeben von:
      getAnnotations in Schnittstelle IAnnotatable
      Setzt außer Kraft:
      getAnnotations in Klasse SourceRefElement
      Gibt zurück:
      the annotations of this element, in the order declared in the source, or 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.
    • 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.
    • 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:
    • 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:
    • getFlags

      public int getFlags() throws JavaModelException
      Beschreibung aus Schnittstelle kopiert: IMember
      Returns the modifier flags for this member. The flags can be examined using class Flags.

      For binary members, flags from the class file as well as derived flags Flags.AccAnnotationDefault and Flags.AccDefaultMethod are included.

      For source members, 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. Source flags include Flags.AccAnnotationDefault as well.

      Angegeben von:
      getFlags in Schnittstelle IMember
      Setzt außer Kraft:
      getFlags in Klasse Member
      Gibt zurück:
      the modifier flags for this member
      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(StringBuffer buff)
      Setzt außer Kraft:
      getHandleMemento in Klasse SourceRefElement
    • 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(boolean forceOpen) throws JavaModelException
      Angegeben von:
      getKey in Klasse BinaryMember
      Löst aus:
      JavaModelException
      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
    • 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.
    • 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.
    • 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:
    • 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:
    • 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.
    • 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.
    • 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.
    • 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, StringBuffer 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(StringBuffer buffer)
      Beschreibung aus Klasse kopiert: JavaElement
      Debugging purposes
      Setzt außer Kraft:
      toStringName in Klasse SourceRefElement
    • toStringName

      protected void toStringName(StringBuffer buffer, int flags)
    • getAttachedJavadoc

      public String getAttachedJavadoc(org.eclipse.core.runtime.IProgressMonitor monitor) throws JavaModelException
      Beschreibung aus Schnittstelle kopiert: IJavaElement

      Returns the Javadoc as HTML source if this element has 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 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.

      Angegeben von:
      getAttachedJavadoc in Schnittstelle IJavaElement
      Setzt außer Kraft:
      getAttachedJavadoc in Klasse JavaElement
      Parameter:
      monitor - the given progress monitor, can be null
      Gibt zurück:
      the extracted javadoc from the attached javadoc, null if none
      Löst aus:
      JavaModelException - if:
      • this element does not exist
      • retrieving the attached javadoc fails (timed-out, invalid URL, ...)
      • the format of the javadoc doesn't match expected standards (different anchors,...)
      Siehe auch: