Java Doc for MethodDeclaration.java in  » IDE-Eclipse » jdt » org » eclipse » jdt » core » dom » Java Source Code / Java DocumentationJava Source Code and Java Documentation

 MethodDeclaration:
 [ Javadoc ] { Modifier } ( Type | void ) Identifier (
 [ FormalParameter 
 { , FormalParameter } ] ) {[ ] }
 [ throws TypeName { , TypeName } ] ( Block | ; )
 ConstructorDeclaration:
 [ Javadoc ] { Modifier } Identifier (
 [ FormalParameter
 { , FormalParameter } ] )
 [throws TypeName { , TypeName } ] Block
 

 MethodDeclaration:
 [ Javadoc ] { ExtendedModifier }
 [ < TypeParameter { , TypeParameter } > ]
 ( Type | void ) Identifier (
 [ FormalParameter 
 { , FormalParameter } ] ) {[ ] }
 [ throws TypeName { , TypeName } ] ( Block | ; )
 ConstructorDeclaration:
 [ Javadoc ] { ExtendedModifier }
 [ < TypeParameter { , TypeParameter } > ]
 Identifier (
 [ FormalParameter
 { , FormalParameter } ] )
 [throws TypeName { , TypeName } ] Block
 

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).

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.

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

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.

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.

N.B. This constructor is package-private; all subclasses must be declared in the same package; clients are unable to declare additional subclasses.

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

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.

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.

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.

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

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.

• the node belongs to a different AST
• the node already has a parent
• a cycle in would be created

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.

• the node belongs to a different AST
• the node already has a parent

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

• the node belongs to a different AST
• the node already has a parent

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.

• the node belongs to a different AST
• the node already has a parent