Package org.eclipse.jdt.core.dom

Class MethodDeclaration

java.lang.Object
org.eclipse.jdt.core.dom.ASTNode
org.eclipse.jdt.core.dom.BodyDeclaration
org.eclipse.jdt.core.dom.MethodDeclaration
public class MethodDeclaration extends BodyDeclaration
Method declaration AST node type. A method declaration is the union of a method declaration and a constructor declaration. 
 MethodDeclaration:
    [ Javadoc ] { ExtendedModifier } [ < TypeParameter { , TypeParameter } > ] ( Type | void )
        Identifier (
            [ ReceiverParameter , ] [ FormalParameter { , FormalParameter } ]
        ) { Dimension }
        [ throws Type { , Type } ]
        ( Block | ; )
 ConstructorDeclaration:
    [ Javadoc ] { ExtendedModifier } [ < TypeParameter { , TypeParameter } > ]
        Identifier (
            [ ReceiverParameter , ] [ FormalParameter { , FormalParameter } ]
        ) { Dimension }
        [ throws Type { , Type } ]
        ( Block | ; )
 CompactConstructorDeclaration:
    [ Javadoc ] ExtendedModifier { ExtendedModifier}
        Identifier
        ( Block | ; )

The ReceiverParameter is represented as: Type [ SimpleName . ] this
The FormalParameter is represented by a SingleVariableDeclaration.

When a Javadoc comment is present, the source range begins with the first character of the "/**" comment delimiter. When there is no Javadoc comment, the source range begins with the first character of the first modifier keyword (if modifiers), or the first character of the "<" token (method, no modifiers, type parameters), or the first character of the return type (method, no modifiers, no type parameters), or the first character of the identifier (constructor, no modifiers). The source range extends through the last character of the ";" token (if no body), or the last character of the block (if body). The compact constructor must be declared public. (jls-8.10.5)

Since:
2.0
Restriction:
This class is not intended to be instantiated by clients.

  • Field Details

    • JAVADOC_PROPERTY

      public static final ChildPropertyDescriptor JAVADOC_PROPERTY
      The "javadoc" structural property of this node type (child type: Javadoc).
      Since:
      3.0

    • MODIFIERS_PROPERTY

      public static final SimplePropertyDescriptor MODIFIERS_PROPERTY
      Deprecated.
      In the JLS3 API, this property is replaced by MODIFIERS2_PROPERTY.
      The "modifiers" structural property of this node type (type: Integer) (JLS2 API only).
      Since:
      3.0

    • MODIFIERS2_PROPERTY

      public static final ChildListPropertyDescriptor MODIFIERS2_PROPERTY
      The "modifiers" structural property of this node type (element type: IExtendedModifier) (added in JLS3 API).
      Since:
      3.1

    • CONSTRUCTOR_PROPERTY

      public static final SimplePropertyDescriptor CONSTRUCTOR_PROPERTY
      The "constructor" structural property of this node type (type: Boolean).
      Since:
      3.0

    • COMPACT_CONSTRUCTOR_PROPERTY

      public static final SimplePropertyDescriptor COMPACT_CONSTRUCTOR_PROPERTY
      The "compact constructor" structural property of record node type (type: Boolean).
      Since:
      3.22

    • NAME_PROPERTY

      public static final ChildPropertyDescriptor NAME_PROPERTY
      The "name" structural property of this node type (child type: SimpleName).
      Since:
      3.0

    • RETURN_TYPE_PROPERTY

      public static final ChildPropertyDescriptor RETURN_TYPE_PROPERTY
      Deprecated.
      In the JLS3 API, this property is replaced by RETURN_TYPE2_PROPERTY.
      The "returnType" structural property of this node type (child type: Type) (JLS2 API only).
      Since:
      3.0

    • RETURN_TYPE2_PROPERTY

      public static final ChildPropertyDescriptor RETURN_TYPE2_PROPERTY
      The "returnType2" structural property of this node type (child type: Type) (added in JLS3 API).
      Since:
      3.1

    • EXTRA_DIMENSIONS_PROPERTY

      public static final SimplePropertyDescriptor EXTRA_DIMENSIONS_PROPERTY
      Deprecated.
      In JLS8 and later, use EXTRA_DIMENSIONS2_PROPERTY instead.
      The "extraDimensions" structural property of this node type (type: Integer) (below JLS8 only).
      Since:
      3.0

    • EXTRA_DIMENSIONS2_PROPERTY

      public static final ChildListPropertyDescriptor EXTRA_DIMENSIONS2_PROPERTY
      The "extraDimensions2" structural property of this node type (element type: Dimension) (added in JLS8 API).
      Since:
      3.10

    • TYPE_PARAMETERS_PROPERTY

      public static final ChildListPropertyDescriptor TYPE_PARAMETERS_PROPERTY
      The "typeParameters" structural property of this node type (element type: TypeParameter) (added in JLS3 API).
      Since:
      3.1

    • PARAMETERS_PROPERTY

      public static final ChildListPropertyDescriptor PARAMETERS_PROPERTY
      The "parameters" structural property of this node type (element type: SingleVariableDeclaration).
      Since:
      3.0

    • RECEIVER_TYPE_PROPERTY

      public static final ChildPropertyDescriptor RECEIVER_TYPE_PROPERTY
      The "receiverType" structural property of this node type (child type: Type) (added in JLS8 API).
      Since:
      3.10

    • RECEIVER_QUALIFIER_PROPERTY

      public static final ChildPropertyDescriptor RECEIVER_QUALIFIER_PROPERTY
      The "receiverQualifier" structural property of this node type (child type: SimpleName) (added in JLS8 API).
      Since:
      3.10

    • THROWN_EXCEPTIONS_PROPERTY

      public static final ChildListPropertyDescriptor THROWN_EXCEPTIONS_PROPERTY
      Deprecated.
      In JLS8 and later, use THROWN_EXCEPTION_TYPES_PROPERTY instead.
      The "thrownExceptions" structural property of this node type (element type: Name) (before JLS8 only).
      Since:
      3.0

    • THROWN_EXCEPTION_TYPES_PROPERTY

      public static final ChildListPropertyDescriptor THROWN_EXCEPTION_TYPES_PROPERTY
      The "thrownExceptionTypes" structural property of this node type (element type: Type) (added in JLS8 API).
      Since:
      3.10

    • BODY_PROPERTY

      public static final ChildPropertyDescriptor BODY_PROPERTY
      The "body" structural property of this node type (child type: Block).
      Since:
      3.0

  • Method Details

    • 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

    • isConstructor

      public boolean isConstructor()
      Returns whether this declaration declares a constructor or a method.
      Returns:
      true if this is a constructor declaration, and false if this is a method declaration

    • setConstructor

      public void setConstructor(boolean isConstructor)
      Sets whether this declaration declares a constructor or a method.
      Parameters:
      isConstructor - true for a constructor declaration, and false for a method declaration

    • isCompactConstructor

      public boolean isCompactConstructor()
      Returns whether this declaration declares a constructor or a method.
      Returns:
      true if this is a compact constructor declaration in a record, and false if this is a method declaration
      Throws:
      UnsupportedOperationException - if this operation is used below JLS16
      Since:
      3.26

    • setCompactConstructor

      public void setCompactConstructor(boolean isCompactConstructor)
      Sets whether this declaration declares a compact constructor in a record or a method.
      Parameters:
      isCompactConstructor - true for a constructor declaration, and false for a method declaration
      Throws:
      UnsupportedOperationException - if this operation is used below JLS16
      Since:
      3.26

    • typeParameters

      public List typeParameters()
      Returns the live ordered list of type parameters of this method declaration (added in JLS3 API). This list is non-empty for parameterized methods.
      Returns:
      the live list of type parameters (element type: TypeParameter)
      Throws:
      UnsupportedOperationException - if this operation is used in a JLS2 AST
      Since:
      3.1

    • getName

      public SimpleName getName()
      Returns the name of the method declared in this method declaration. For a constructor declaration, this should be the same as the name of the class.
      Returns:
      the method name node

    • setName

      public void setName(SimpleName methodName)
      Sets the name of the method declared in this method declaration to the given name. For a constructor declaration, this should be the same as the name of the class.
      Parameters:
      methodName - the new method name
      Throws:
      IllegalArgumentException - if:
      • the node belongs to a different AST
      • the node already has a parent

    • getReceiverType

      public Type getReceiverType()
      Returns the receiver type explicitly declared in the method or constructor declaration (added in JLS8 API). If the receiver is not explicitly declared in the method or constructor declaration, null is returned.
      Returns:
      the receiver type or null if receiver is not declared explicitly
      Throws:
      UnsupportedOperationException - if this operation is used below JLS8
      Since:
      3.10

    • setReceiverType

      public void setReceiverType(Type receiverType)
      Sets or clears the given type as the type of explicit receiver parameter (added in JLS8 API).

      A receiver type is only legal in Java code if it appears on an instance method or on a constructor of an inner class.

      Parameters:
      receiverType - type of the explicit receiver parameter, or null if there is none
      Throws:
      UnsupportedOperationException - if this operation is used below JLS8
      Since:
      3.10

    • getReceiverQualifier

      public SimpleName getReceiverQualifier()
      Returns the qualifying name, if any, for the explicit receiver or null if not used (added in JLS8 API).

      A receiver qualifier is only legal in Java code if it appears on a constructor of an inner class.

      Returns:
      the qualifying name or null if a qualifier was not specified
      Throws:
      UnsupportedOperationException - if this operation is used below JLS8
      Since:
      3.10

    • setReceiverQualifier

      public void setReceiverQualifier(SimpleName receiverQualifier)
      Sets the given simple name as the qualifier for the receiver (added in JLS8 API).
      Parameters:
      receiverQualifier - explicit receiver parameter to be added to the method declaration
      Throws:
      UnsupportedOperationException - if this operation is used below JLS8
      Since:
      3.10

    • parameters

      public List parameters()
      Returns the live ordered list of method parameter declarations for this method declaration.
      Returns:
      the live list of method parameter declarations (element type: SingleVariableDeclaration)

    • isVarargs

      public boolean isVarargs()
      Returns whether this method declaration declares a variable arity method (added in JLS3 API). The convenience method checks whether the last parameter is so marked.
      Returns:
      true if this is a variable arity method declaration, and false otherwise
      Throws:
      UnsupportedOperationException - if this operation is used in a JLS2 AST
      Since:
      3.1
      See Also:

    • thrownExceptions

      public List thrownExceptions()
      Deprecated.
      In the JLS8 API, this method is replaced by thrownExceptionTypes().
      Returns the live ordered list of thrown exception names in this method declaration (below JLS8 API only).
      Returns:
      the live list of exception names (element type: Name)
      Throws:
      UnsupportedOperationException - if this operation is used in a JLS8 or later AST

    • thrownExceptionTypes

      public List thrownExceptionTypes()
      Returns the live ordered list of thrown exception types in this method declaration.
      Returns:
      the live list of exception types (element type: Type)
      Throws:
      UnsupportedOperationException - if this operation is used in a JLS2, JLS3 or JLS4 AST
      Since:
      3.10

    • getReturnType

      public Type getReturnType()
      Deprecated.
      In the JLS3 API, this method is replaced by getReturnType2(), which may return null.
      Returns the return type of the method declared in this method declaration, exclusive of any extra array dimensions (JLS2 API only). This is one of the few places where the void type is meaningful.

      Note that this child is not relevant for constructor declarations (although, it does still figure in subtree equality comparisons and visits), and is devoid of the binding information ordinarily available.

      Returns:
      the return type, possibly the void primitive type
      Throws:
      UnsupportedOperationException - if this operation is used in an AST later than JLS2

    • setReturnType

      public void setReturnType(Type type)
      Deprecated.
      In the JLS3 API, this method is replaced by setReturnType2(Type), which accepts null.
      Sets the return type of the method declared in this method declaration to the given type, exclusive of any extra array dimensions (JLS2 API only). This is one of the few places where the void type is meaningful.

      Note that this child is not relevant for constructor declarations (although it does still figure in subtree equality comparisons and visits).

      Parameters:
      type - the new return type, possibly the void primitive type
      Throws:
      IllegalArgumentException - if:
      • the node belongs to a different AST
      • the node already has a parent
      UnsupportedOperationException - if this operation is used in an AST later than JLS2

    • getReturnType2

      public Type getReturnType2()
      Returns the return type of the method declared in this method declaration, exclusive of any extra array dimensions (added in JLS3 API). This is one of the few places where the void type is meaningful.

      Note that this child is not relevant for constructor declarations (although, if present, it does still figure in subtree equality comparisons and visits), and is devoid of the binding information ordinarily available. In the JLS2 API, the return type is mandatory. In the JLS3 API, the return type is optional.

      Returns:
      the return type, possibly the void primitive type, or null if none
      Throws:
      UnsupportedOperationException - if this operation is used in a JLS2 AST
      Since:
      3.1

    • setReturnType2

      public void setReturnType2(Type type)
      Sets the return type of the method declared in this method declaration to the given type, exclusive of any extra array dimensions (added in JLS3 API). This is one of the few places where the void type is meaningful.

      Note that this child is not relevant for constructor declarations (although it does still figure in subtree equality comparisons and visits). In the JLS2 API, the return type is mandatory. In the JLS3 API, the return type is optional.

      Parameters:
      type - the new return type, possibly the void primitive type, or null if none
      Throws:
      UnsupportedOperationException - if this operation is used in a JLS2 AST
      IllegalArgumentException - if:
      • the node belongs to a different AST
      • the node already has a parent
      Since:
      3.1

    • getExtraDimensions

      public int getExtraDimensions()
      Returns the number of extra array dimensions over and above the explicitly-specified return type.

      For example, int foo()[][] has a return type of int and two extra array dimensions; int[][] foo() has a return type of int[][] and zero extra array dimensions. The two constructs have different ASTs, even though there are really syntactic variants of the same method declaration.

      In the JLS8 API, this method is a convenience method that counts extraDimensions().

      Returns:
      the number of extra array dimensions
      Since:
      2.1

    • setExtraDimensions

      public void setExtraDimensions(int dimensions)
      Deprecated.
      In the JLS8 API, this method is replaced by extraDimensions() which contains a list of Dimension nodes.
      Sets the number of extra array dimensions over and above the explicitly-specified return type.

      For example, int foo()[][] is rendered as a return type of int with two extra array dimensions; int[][] foo() is rendered as a return type of int[][] with zero extra array dimensions. The two constructs have different ASTs, even though there are really syntactic variants of the same method declaration.

      Parameters:
      dimensions - the number of array dimensions
      Throws:
      IllegalArgumentException - if the number of dimensions is negative
      UnsupportedOperationException - if this operation is used in a JLS8 or later AST
      Since:
      2.1

    • extraDimensions

      public List extraDimensions()
      Returns the live ordered list of extra dimensions with optional annotations (added in JLS8 API).
      Returns:
      the live list of extra dimensions with optional annotations (element type: Dimension)
      Throws:
      UnsupportedOperationException - if this operation is used below JLS8
      Since:
      3.10

    • getBody

      public Block getBody()
      Returns the body of this method declaration, or null if this method has no body.

      Note that there is a subtle difference between having no body and having an empty body ("{}").

      Returns:
      the method body, or null if this method has no body

    • setBody

      public void setBody(Block body)
      Sets or clears the body of this method declaration.

      Note that there is a subtle difference between having no body (as in "void foo();") and having an empty body (as in "void foo() {}"). Abstract methods, and methods declared in interfaces, have no body. Non-abstract methods, and all constructors, have a body.

      Parameters:
      body - the block node, or null if there is none
      Throws:
      IllegalArgumentException - if:
      • the node belongs to a different AST
      • the node already has a parent
      • a cycle in would be created

    • resolveBinding

      public IMethodBinding resolveBinding()
      Resolves and returns the binding for the method or constructor declared in this method or constructor declaration.

      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