org.aspectj.org.eclipse.jdt.core.dom.FileASTRequestor 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) 2010 IBM Corporation and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.aspectj.org.eclipse.jdt.core.dom;

/**
 * An AST requestor handles ASTs for compilation units passed to
 * {@link ASTParser#createASTs(String[], String[], String[], FileASTRequestor, org.eclipse.core.runtime.IProgressMonitor) ASTParser.createASTs}.
 * 
 * {@link FileASTRequestor#acceptAST(String, CompilationUnit) FileASTRequestor.acceptAST} is called for each of the
 * compilation units passed to {@link ASTParser#createASTs(String[], String[], String[], FileASTRequestor, org.eclipse.core.runtime.IProgressMonitor) ASTParser.createASTs}.
 * After all the compilation units have been processed,
 * {@link #acceptBinding(String, IBinding) FileASTRequestor.acceptBinding} is called for each
 * of the binding keys passed to {@link ASTParser#createASTs(String[], String[], String[], FileASTRequestor, org.eclipse.core.runtime.IProgressMonitor) ASTParser.createASTs}.
 * 
 * 
 * This class is intended to be subclassed by clients.
 * AST requestors are serially reusable, but neither reentrant nor thread-safe.
 * 
 *
 * @see ASTParser#createASTs(String[], String[], String[], FileASTRequestor, org.eclipse.core.runtime.IProgressMonitor)
 * @since 3.6
 */
public abstract class FileASTRequestor {

	/**
	 * The compilation unit resolver used to resolve bindings, or
	 * null if none. Note that this field is non-null
	 * only within the dynamic scope of a call to
	 * ASTParser.createASTs.
	 */
	CompilationUnitResolver compilationUnitResolver = null;

	/**
	 * Accepts an AST corresponding to the compilation unit.
	 * That is, ast is an AST for source.
	 * 
	 * The default implementation of this method does nothing.
	 * Clients should override to process the resulting AST.
	 * 
	 *
	 * @param sourceFilePath the compilation unit the given ast is coming from
	 * @param ast the requested abstract syntax tree
	 */
	public void acceptAST(String sourceFilePath, CompilationUnit ast) {
		// do nothing
	}

	/**
	 * Accepts a binding corresponding to the binding key.
	 * That is, binding is the binding for
	 * bindingKey; binding is null
	 * if the key cannot be resolved.
	 * 
	 * The default implementation of this method does nothing.
	 * Clients should override to process the resulting binding.
	 * 
	 *
	 * @param bindingKey the key of the requested binding
	 * @param binding the requested binding, or null if none
	 */
	public void acceptBinding(String bindingKey, IBinding binding) {
		// do nothing
	}

	/**
	 * Resolves bindings for the given binding keys.
	 * The given binding keys must have been obtained earlier
	 * using {@link IBinding#getKey()}.
	 * 
	 * If a binding key cannot be resolved, null is put in the resulting array.
	 * Bindings can only be resolved in the dynamic scope of a ASTParser.createASTs,
	 * and only if ASTParser.resolveBindings(true) was specified.
	 * 
	 * 
	 * Caveat: During an acceptAST callback, there are implementation
	 * limitations concerning the look up of binding keys representing local elements.
	 * In some cases, the binding is unavailable, and null will be returned.
	 * This is only an issue during an acceptAST callback, and only
	 * when the binding key represents a local element (e.g., local variable,
	 * local class, method declared in anonymous class). There is no such limitation
	 * outside of acceptAST callbacks, or for top-level types and their
	 * members even within acceptAST callbacks.
	 * 
	 *
	 * @param bindingKeys the binding keys to look up
	 * @return a list of bindings paralleling the bindingKeys parameter,
	 * with null entries for keys that could not be resolved
	 */
	public final IBinding[] createBindings(String[] bindingKeys) {
		int length = bindingKeys.length;
		IBinding[] result = new IBinding[length];
		for (int i = 0; i < length; i++) {
			result[i] = null;
			if (this.compilationUnitResolver != null) {
				result[i] = this.compilationUnitResolver.createBinding(bindingKeys[i]);
			}
		}
		return result;
	}
}