org.eclipse.jdt.core.dom
Class BodyDeclaration

java.lang.Object
  |
  +--org.eclipse.jdt.core.dom.ASTNode
        |
        +--org.eclipse.jdt.core.dom.BodyDeclaration

Direct Known Subclasses:

FieldDeclaration, Initializer, MethodDeclaration, TypeDeclaration

public abstract class BodyDeclaration

extends ASTNode

Abstract base class of all AST nodes that represent body declarations that may appear in the body of a class or interface declaration.

 ClassBodyDeclaration:
		ClassDeclaration
		InterfaceDeclaration
		MethodDeclaration
 		ConstructorDeclaration
 		FieldDeclaration
 		Initializer
 InterfaceBodyDeclaration:
		ClassDeclaration
		InterfaceDeclaration
		MethodDeclaration
 		FieldDeclaration
 

Most types of body declarations can carry a Javadoc comment; Initializer is the only ones that does not. The source range for body declarations always includes the Javadoc comment if present.

Since:

2.0

Field Summary

Fields inherited from class org.eclipse.jdt.core.dom.ASTNode

ANONYMOUS_CLASS_DECLARATION, ARRAY_ACCESS, ARRAY_CREATION, ARRAY_INITIALIZER, ARRAY_TYPE, ASSERT_STATEMENT, ASSIGNMENT, BLOCK, BOOLEAN_LITERAL, BREAK_STATEMENT, CAST_EXPRESSION, CATCH_CLAUSE, CHARACTER_LITERAL, CLASS_INSTANCE_CREATION, COMPILATION_UNIT, CONDITIONAL_EXPRESSION, CONSTRUCTOR_INVOCATION, CONTINUE_STATEMENT, DO_STATEMENT, EMPTY_STATEMENT, EXPRESSION_STATEMENT, FIELD_ACCESS, FIELD_DECLARATION, FOR_STATEMENT, IF_STATEMENT, IMPORT_DECLARATION, INFIX_EXPRESSION, INITIALIZER, INSTANCEOF_EXPRESSION, JAVADOC, LABELED_STATEMENT, MALFORMED, METHOD_DECLARATION, METHOD_INVOCATION, NULL_LITERAL, NUMBER_LITERAL, PACKAGE_DECLARATION, PARENTHESIZED_EXPRESSION, POSTFIX_EXPRESSION, PREFIX_EXPRESSION, PRIMITIVE_TYPE, QUALIFIED_NAME, RETURN_STATEMENT, SIMPLE_NAME, SIMPLE_TYPE, SINGLE_VARIABLE_DECLARATION, STRING_LITERAL, SUPER_CONSTRUCTOR_INVOCATION, SUPER_FIELD_ACCESS, SUPER_METHOD_INVOCATION, SWITCH_CASE, SWITCH_STATEMENT, SYNCHRONIZED_STATEMENT, THIS_EXPRESSION, THROW_STATEMENT, TRY_STATEMENT, TYPE_DECLARATION, TYPE_DECLARATION_STATEMENT, TYPE_LITERAL, VARIABLE_DECLARATION_EXPRESSION, VARIABLE_DECLARATION_FRAGMENT, VARIABLE_DECLARATION_STATEMENT, WHILE_STATEMENT

Method Summary

Javadoc	getJavadoc() Returns the Javadoc comment node.
void	setJavadoc(Javadoc javadoc) Sets or clears the Javadoc comment node.

Methods inherited from class org.eclipse.jdt.core.dom.ASTNode

accept, copySubtree, copySubtrees, equals, getAST, getFlags, getLength, getNodeType, getParent, getProperty, getRoot, getStartPosition, properties, setFlags, setProperty, setSourceRange, subtreeBytes, subtreeMatch, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getJavadoc

public Javadoc getJavadoc()

Returns the Javadoc comment node.

Returns:

the javadoc comment node, or null if none

setJavadoc

public void setJavadoc(Javadoc javadoc)

Sets or clears the Javadoc comment node.

Parameters:

javadoc - the javadoc comment node, or null if none

Throws:

IllegalArgumentException - if the Java comment string is invalid