Class MemberRef

  • All Implemented Interfaces:
    IDocElement

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

      • QUALIFIER_PROPERTY

        public static final ChildPropertyDescriptor QUALIFIER_PROPERTY
        The "qualifier" structural property of this node type (child type: Name).
        Since:
        3.0
    • 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 member 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 member 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 member.
        Returns:
        the member name node
      • setName

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

        public final IBinding resolveBinding()
        Resolves and returns the binding for the entity referred to by this member 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