org.aspectj.org.eclipse.jdt.core.dom
Class AdviceDeclaration

java.lang.Object
  extended by org.aspectj.org.eclipse.jdt.core.dom.ASTNode
      extended by org.aspectj.org.eclipse.jdt.core.dom.BodyDeclaration
          extended by org.aspectj.org.eclipse.jdt.core.dom.AdviceDeclaration
Direct Known Subclasses:
AfterAdviceDeclaration, AroundAdviceDeclaration, BeforeAdviceDeclaration

public abstract class AdviceDeclaration
extends BodyDeclaration

AdviceDeclaration DOM AST node. Source code forked from MethodDeclaration. An abstract AdviceDeclaration is just like a MethodDeclaration, but without a name or return type.


Field Summary
static ChildPropertyDescriptor BODY_PROPERTY
          The "body" structural property of this node type.
static ChildPropertyDescriptor JAVADOC_PROPERTY
          The "javadoc" structural property of this node type.
protected  org.aspectj.org.eclipse.jdt.core.dom.ASTNode.NodeList parameters
          The parameter declarations (element type: SingleVariableDeclaration).
static ChildListPropertyDescriptor PARAMETERS_PROPERTY
          The "parameters" structural property of this node type).
static ChildPropertyDescriptor POINTCUT_PROPERTY
           
protected static java.util.List PROPERTY_DESCRIPTORS_2_0
          A list of property descriptors (element type: StructuralPropertyDescriptor), or null if uninitialized.
protected static java.util.List PROPERTY_DESCRIPTORS_3_0
          A list of property descriptors (element type: StructuralPropertyDescriptor), or null if uninitialized.
static ChildListPropertyDescriptor THROWN_EXCEPTIONS_PROPERTY
          The "thrownExceptions" structural property of this node type).
protected  org.aspectj.org.eclipse.jdt.core.dom.ASTNode.NodeList thrownExceptions
          The list of thrown exception names (element type: Name).
 
Fields inherited from class org.aspectj.org.eclipse.jdt.core.dom.ASTNode
ANNOTATION_TYPE_DECLARATION, ANNOTATION_TYPE_MEMBER_DECLARATION, ANONYMOUS_CLASS_DECLARATION, ARRAY_ACCESS, ARRAY_CREATION, ARRAY_INITIALIZER, ARRAY_TYPE, ASSERT_STATEMENT, ASSIGNMENT, BLOCK, BLOCK_COMMENT, 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, ENHANCED_FOR_STATEMENT, ENUM_CONSTANT_DECLARATION, ENUM_DECLARATION, EXPRESSION_STATEMENT, FIELD_ACCESS, FIELD_DECLARATION, FOR_STATEMENT, IF_STATEMENT, IMPORT_DECLARATION, INFIX_EXPRESSION, INITIALIZER, INSTANCEOF_EXPRESSION, JAVADOC, LABELED_STATEMENT, LINE_COMMENT, MALFORMED, MARKER_ANNOTATION, MEMBER_REF, MEMBER_VALUE_PAIR, METHOD_DECLARATION, METHOD_INVOCATION, METHOD_REF, METHOD_REF_PARAMETER, MODIFIER, NORMAL_ANNOTATION, NULL_LITERAL, NUMBER_LITERAL, ORIGINAL, PACKAGE_DECLARATION, PARAMETERIZED_TYPE, PARENTHESIZED_EXPRESSION, POSTFIX_EXPRESSION, PREFIX_EXPRESSION, PRIMITIVE_TYPE, PROTECT, QUALIFIED_NAME, QUALIFIED_TYPE, RECOVERED, RETURN_STATEMENT, SIMPLE_NAME, SIMPLE_TYPE, SINGLE_MEMBER_ANNOTATION, SINGLE_VARIABLE_DECLARATION, STRING_LITERAL, SUPER_CONSTRUCTOR_INVOCATION, SUPER_FIELD_ACCESS, SUPER_METHOD_INVOCATION, SWITCH_CASE, SWITCH_STATEMENT, SYNCHRONIZED_STATEMENT, TAG_ELEMENT, TEXT_ELEMENT, THIS_EXPRESSION, THROW_STATEMENT, TRY_STATEMENT, TYPE_DECLARATION, TYPE_DECLARATION_STATEMENT, TYPE_LITERAL, TYPE_PARAMETER, UNION_TYPE, VARIABLE_DECLARATION_EXPRESSION, VARIABLE_DECLARATION_FRAGMENT, VARIABLE_DECLARATION_STATEMENT, WHILE_STATEMENT, WILDCARD_TYPE
 
Method Summary
 Block getBody()
          Returns the body of this method declaration, or null if this method has no body.
 PointcutDesignator getPointcut()
           
 java.util.List parameters()
          Returns the live ordered list of method parameter declarations for this method declaration.
static java.util.List propertyDescriptors(int apiLevel)
          Returns a list of structural property descriptors for this node type.
 void setBody(Block body)
          Sets or clears the body of this method declaration.
 void setPointcut(PointcutDesignator pointcut)
           
 java.util.List thrownExceptions()
          Returns the live ordered list of thrown exception names in this method declaration.
 
Methods inherited from class org.aspectj.org.eclipse.jdt.core.dom.BodyDeclaration
getJavadoc, getJavadocProperty, getModifiers, getModifiersProperty, modifiers, setJavadoc, setModifiers
 
Methods inherited from class org.aspectj.org.eclipse.jdt.core.dom.ASTNode
accept, copySubtree, copySubtrees, delete, equals, getAST, getFlags, getLength, getLocationInParent, getNodeType, getParent, getProperty, getRoot, getStartPosition, getStructuralProperty, hashCode, nodeClassForType, properties, setFlags, setProperty, setSourceRange, setStructuralProperty, structuralPropertiesForType, subtreeBytes, subtreeMatch, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

JAVADOC_PROPERTY

public static final ChildPropertyDescriptor JAVADOC_PROPERTY
The "javadoc" structural property of this node type.

Since:
3.0

PARAMETERS_PROPERTY

public static final ChildListPropertyDescriptor PARAMETERS_PROPERTY
The "parameters" structural property of this node type).

Since:
3.0

POINTCUT_PROPERTY

public static final ChildPropertyDescriptor POINTCUT_PROPERTY

THROWN_EXCEPTIONS_PROPERTY

public static final ChildListPropertyDescriptor THROWN_EXCEPTIONS_PROPERTY
The "thrownExceptions" structural property of this node type).

Since:
3.0

BODY_PROPERTY

public static final ChildPropertyDescriptor BODY_PROPERTY
The "body" structural property of this node type.

Since:
3.0

PROPERTY_DESCRIPTORS_2_0

protected static java.util.List PROPERTY_DESCRIPTORS_2_0
A list of property descriptors (element type: StructuralPropertyDescriptor), or null if uninitialized.

Since:
3.0

PROPERTY_DESCRIPTORS_3_0

protected static java.util.List PROPERTY_DESCRIPTORS_3_0
A list of property descriptors (element type: StructuralPropertyDescriptor), or null if uninitialized.

Since:
3.1

parameters

protected org.aspectj.org.eclipse.jdt.core.dom.ASTNode.NodeList parameters
The parameter declarations (element type: SingleVariableDeclaration). Defaults to an empty list.


thrownExceptions

protected org.aspectj.org.eclipse.jdt.core.dom.ASTNode.NodeList thrownExceptions
The list of thrown exception names (element type: Name). Defaults to an empty list.

Method Detail

propertyDescriptors

public static java.util.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

getPointcut

public PointcutDesignator getPointcut()

setPointcut

public void setPointcut(PointcutDesignator pointcut)

parameters

public java.util.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)

thrownExceptions

public java.util.List thrownExceptions()
Returns the live ordered list of thrown exception names in this method declaration.

Returns:
the live list of exception names (element type: Name)

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:
java.lang.IllegalArgumentException - if:
  • the node belongs to a different AST
  • the node already has a parent
  • a cycle in would be created