Package 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:
AbstractTypeDeclaration, AnnotationTypeMemberDeclaration, EnumConstantDeclaration, FieldDeclaration, Initializer, MethodDeclaration
public abstract class BodyDeclaration extends ASTNode
Abstract base class of all AST nodes that represent body declarations that may appear in the body of some kind of class or interface declaration, including anonymous class declarations, enumeration declarations, and enumeration constant declarations. 
 BodyDeclaration:
                AbstractTypeDeclaration
                        AnnotationTypeDeclaration
                        EnumDeclaration
                        TypeDeclaration (for classes and interfaces)
                AnnotationTypeMemberDeclaration
                EnumConstantDeclaration
                FieldDeclaration
                Initializer
                MethodDeclaration (for methods and constructors)

All types of body declarations carry modifiers (and annotations), although they differ in which modifiers are allowed. Most types of body declarations can carry a doc comment; Initializer is the only ones that does not. The source range for body declarations always includes the doc comment if present.

Since:
2.0

  • Method Details

    • getModifiersProperty

      public final ChildListPropertyDescriptor getModifiersProperty()
      Returns structural property descriptor for the "modifiers" property of this node as used in JLS3 (element type: IExtendedModifier).
      Returns:
      the property descriptor
      Since:
      3.1

    • getJavadocProperty

      public final ChildPropertyDescriptor getJavadocProperty()
      Returns structural property descriptor for the "javadoc" property of this node (child type: Javadoc).
      Returns:
      the property descriptor
      Since:
      3.1

    • getJavadoc

      public Javadoc getJavadoc()
      Returns the doc comment node.
      Returns:
      the doc comment node, or null if none

    • setJavadoc

      public void setJavadoc(Javadoc docComment)
      Sets or clears the doc comment node.
      Parameters:
      docComment - the doc comment node, or null if none
      Throws:
      IllegalArgumentException - if the doc comment string is invalid

    • getModifiers

      public int getModifiers()
      Returns the modifiers explicitly specified on this declaration.

      In the JLS3 API, this method is a convenience method that computes these flags from modifiers().

      Returns:
      the bit-wise "or" of Modifier constants
      See Also:

    • setModifiers

      public void setModifiers(int modifiers)
      Deprecated.
      In the JLS3 API, this method is replaced by modifiers(), which contains a list of Modifier nodes.
      Sets the modifiers explicitly specified on this declaration (JLS2 API only).
      Parameters:
      modifiers - the given modifiers (bit-wise "or" of Modifier constants)
      Throws:
      UnsupportedOperationException - if this operation is used in an AST later than JLS2
      See Also:

    • modifiers

      public List modifiers()
      Returns the live ordered list of modifiers and annotations of this declaration (added in JLS3 API).
      Returns:
      the live list of modifiers and annotations (element type: IExtendedModifier)
      Throws:
      UnsupportedOperationException - if this operation is used in a JLS2 AST
      Since:
      3.1