org.aspectj.org.eclipse.jdt.core.dom.AfterReturningAdviceDeclaration Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of aspectjtools Show documentation

AspectJ tools most notably contains the AspectJ compiler (AJC). AJC applies aspects to Java classes during compilation, fully replacing Javac for plain Java classes and also compiling native AspectJ or annotation-based @AspectJ syntax. Furthermore, AJC can weave aspects into existing class files in a post-compile binary weaving step. This library is a superset of AspectJ weaver and hence also of AspectJ runtime.

There is a newer version: 1.9.22.1

Show newest version

/*******************************************************************************
 * Copyright (c) 2000, 2005 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/org/documents/epl-2.0/EPL-2.0.txt
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/

package org.aspectj.org.eclipse.jdt.core.dom;

import java.util.ArrayList;
import java.util.List;

/**
 * AfterReturningAdviceDeclaration DOM AST node.
 * has:
 *   everything an AfterAdviceDeclaration has,
 *   an optional returning property
 *
 * It inherits property descriptors from AdviceDeclaration,
 * but needs to add one for its returning property,
 * but I can't mix descripters from two different classes in a property list,
 * so I have to redefine them all here and use
 * a 'returning' prefix to distinguish them from the ones defined in AdviceDeclaration.
 * There has to be a better way, but this works.
 * @author ajh02
 *
 */

public class AfterReturningAdviceDeclaration extends AfterAdviceDeclaration {

	public static final ChildPropertyDescriptor returningJAVADOC_PROPERTY =
		internalJavadocPropertyFactory(AfterReturningAdviceDeclaration.class);

	public static final ChildListPropertyDescriptor returningPARAMETERS_PROPERTY =
		new ChildListPropertyDescriptor(AfterReturningAdviceDeclaration.class, "parameters", SingleVariableDeclaration.class, CYCLE_RISK); //$NON-NLS-1$

	public static final ChildPropertyDescriptor returningPOINTCUT_PROPERTY =
		new ChildPropertyDescriptor(AfterReturningAdviceDeclaration.class, "pointcut", PointcutDesignator.class, MANDATORY, NO_CYCLE_RISK); //$NON-NLS-1$

	public static final ChildListPropertyDescriptor returningTHROWN_EXCEPTIONS_PROPERTY =
		new ChildListPropertyDescriptor(AfterReturningAdviceDeclaration.class, "thrownExceptions", Name.class, NO_CYCLE_RISK); //$NON-NLS-1$

	public static final ChildPropertyDescriptor returningBODY_PROPERTY =
		new ChildPropertyDescriptor(AfterReturningAdviceDeclaration.class, "body", Block.class, OPTIONAL, CYCLE_RISK); //$NON-NLS-1$

	protected static List returningPROPERTY_DESCRIPTORS_2_0;

	protected static List returningPROPERTY_DESCRIPTORS_3_0;

	public static final ChildPropertyDescriptor returningRETURNING_PROPERTY =
		new ChildPropertyDescriptor(AfterReturningAdviceDeclaration.class, "returning", SingleVariableDeclaration.class, OPTIONAL, NO_CYCLE_RISK); //$NON-NLS-1$

	public static List propertyDescriptors(int apiLevel) {
		if (apiLevel == AST.JLS2_INTERNAL) {
			return returningPROPERTY_DESCRIPTORS_2_0;
		} else {
			return returningPROPERTY_DESCRIPTORS_3_0;
		}
	}

	static {
		List propertyList = new ArrayList(6);
		createPropertyList(AfterReturningAdviceDeclaration.class, propertyList);
		addProperty(returningJAVADOC_PROPERTY, propertyList);
		addProperty(returningPARAMETERS_PROPERTY, propertyList);
		addProperty(returningTHROWN_EXCEPTIONS_PROPERTY, propertyList);
		addProperty(returningPOINTCUT_PROPERTY, propertyList);
		addProperty(returningRETURNING_PROPERTY, propertyList);
		addProperty(returningBODY_PROPERTY, propertyList);
		returningPROPERTY_DESCRIPTORS_2_0 = reapPropertyList(propertyList);

		propertyList = new ArrayList(6);
		createPropertyList(AfterReturningAdviceDeclaration.class, propertyList);
		addProperty(returningJAVADOC_PROPERTY, propertyList);
		addProperty(returningPARAMETERS_PROPERTY, propertyList);
		addProperty(returningTHROWN_EXCEPTIONS_PROPERTY, propertyList);
		addProperty(returningPOINTCUT_PROPERTY, propertyList);
		addProperty(returningRETURNING_PROPERTY, propertyList);
		addProperty(returningBODY_PROPERTY, propertyList);
		returningPROPERTY_DESCRIPTORS_3_0 = reapPropertyList(propertyList);
	}

	private SingleVariableDeclaration returning = null;

	AfterReturningAdviceDeclaration(AST ast) {
		super(ast);
	}

	final ASTNode internalGetSetChildProperty(ChildPropertyDescriptor property, boolean get, ASTNode child) {
		if (property == returningRETURNING_PROPERTY) {
			if (get) {
				return getReturning();
			} else {
				setReturning((SingleVariableDeclaration) child);
				return null;
			}
		}
		return super.internalGetSetChildProperty(property, get, child);
	}

	public SingleVariableDeclaration getReturning() {
		return returning;
	}

	public void setReturning(SingleVariableDeclaration returning) {
		this.returning = returning;
	}

	ASTNode clone0(AST target) {
		AfterReturningAdviceDeclaration result = new AfterReturningAdviceDeclaration(target);
		result.setSourceRange(this.getStartPosition(), this.getLength());
		result.setJavadoc(
			(Javadoc) ASTNode.copySubtree(target, getJavadoc()));
		result.parameters().addAll(
			ASTNode.copySubtrees(target, parameters()));
		result.setPointcut(getPointcut());
		result.setReturning(returning);
		result.thrownExceptions().addAll(
			ASTNode.copySubtrees(target, thrownExceptions()));
		result.setBody(
			(Block) ASTNode.copySubtree(target, getBody()));
		return result;
	}

	int treeSize() {
		return
			super.treeSize()
			+ (this.returning == null ? 0 : this.returning.treeSize());
	}

	void accept0(ASTVisitor visitor) {
		if (visitor instanceof AjASTVisitor) {
			boolean visitChildren = ((AjASTVisitor)visitor).visit(this);
			if (visitChildren) {
				// visit children in normal left to right reading order
				acceptChild(visitor, getJavadoc());
				acceptChildren(visitor, this.parameters);
				acceptChild(visitor, getPointcut());
				acceptChild(visitor, getReturning());
				acceptChildren(visitor, this.thrownExceptions);
				acceptChild(visitor, getBody());
			}
			((AjASTVisitor)visitor).endVisit(this);
		}
	}
}