Class MethodRef

  • All Implemented Interfaces:
    IDocElement

    public class MethodRef
    extends ASTNode
    implements IDocElement
    AST node for a method or constructor reference within a doc comment (Javadoc). The principal uses of these are in "@see" and "@link" tag elements, for references to method and constructor members.
     MethodRef:
         [ Name ] # Identifier
             ( [ MethodRefParameter | { , MethodRefParameter } ] )
     
    Since:
    3.0
    See Also:
    Javadoc
    Restriction:
    This class is not intended to be instantiated by clients.
    • Method Detail

      • propertyDescriptors

        public static List propertyDescriptors​(int apiLevel)
        Returns a list of structural property descriptors for this node type. Clients must not modify the result.
        Parameters:
        apiLevel - the API level; one of the AST.JLS* constants
        Returns:
        a list of property descriptors (element type: StructuralPropertyDescriptor)
        Since:
        3.0
      • getQualifier

        public Name getQualifier()
        Returns the qualifier of this method reference, or null if there is none.
        Returns:
        the qualifier name node, or null if there is none
      • setQualifier

        public void setQualifier​(Name name)
        Sets or clears the qualifier of this method reference.
        Parameters:
        name - the qualifier name node, or null if there is none
        Throws:
        IllegalArgumentException - if:
        • the node belongs to a different AST
        • the node already has a parent
      • getName

        public SimpleName getName()
        Returns the name of the referenced method or constructor.
        Returns:
        the method or constructor name node
      • setName

        public void setName​(SimpleName name)
        Sets the name of the referenced method or constructor to the given name.
        Parameters:
        name - the new method or constructor name node
        Throws:
        IllegalArgumentException - if:
        • the name is null
        • the node belongs to a different AST
        • the node already has a parent
      • parameters

        public List parameters()
        Returns the live ordered list of method parameter references for this method reference.
        Returns:
        the live list of method parameter references (element type: MethodRefParameter)
      • resolveBinding

        public final IBinding resolveBinding()
        Resolves and returns the binding for the entity referred to by this method reference.

        Note that bindings are generally unavailable unless requested when the AST is being built.

        Returns:
        the binding, or null if the binding cannot be resolved