org.aspectj.asm.IHierarchy Maven / Gradle / Ivy

Go to download

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

The AspectJ weaver applies aspects to Java classes. It can be used as a Java agent in order to apply load-time weaving (LTW) during class-loading and also contains the AspectJ runtime classes.

There is a newer version: 1.9.22.1

Show newest version

/* *******************************************************************
 * Copyright (c) 2003,2010 Contributors
 * 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:
 *     Mik Kersten     initial implementation
 *     Andy Clement
 * ******************************************************************/
package org.aspectj.asm;

import java.io.Serializable;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;

import org.aspectj.asm.internal.ProgramElement;
import org.aspectj.bridge.ISourceLocation;

/**
 * @author Mik Kersten
 * @author Andy Clement
 */
public interface IHierarchy extends Serializable {

	IProgramElement NO_STRUCTURE = new ProgramElement(null, "",
			IProgramElement.Kind.ERROR, null);

	IProgramElement getElement(String handle);

	IProgramElement getRoot();

	void setRoot(IProgramElement root);

	void addToFileMap(String canonicalFilePath, IProgramElement compilationUnitProgramElement);

	boolean removeFromFileMap(String canonicalFilePath);

	void setFileMap(Map fileMap);

	default void setFileMap(HashMap fileMap) {
		setFileMap((Map) fileMap);
	}

	IProgramElement findInFileMap(String key);

	Set> getFileMapEntrySet();

	boolean isValid();

	IProgramElement findElementForHandle(String handle);

	IProgramElement findElementForHandleOrCreate(String handle, boolean create);

	/**
	 * Returns the first match
	 *
	 * @param parent
	 * @param kind not null
	 * @return null if not found
	 */
	IProgramElement findElementForSignature(IProgramElement parent, IProgramElement.Kind kind, String signature);

	/**
	 * Returns the first match
	 *
	 * @param parent
	 * @param kind not null
	 * @return null if not found
	 */
	IProgramElement findElementForLabel(IProgramElement parent, IProgramElement.Kind kind, String label);

	/**
	 * @param packageName if null default package is searched
	 * @param typeName can't be null
	 */
	IProgramElement findElementForType(String packageName, String typeName);

	/**
	 * @param sourceFile modified to '/' delimited path for consistency
	 * @return a new structure node for the file if it was not found in the model
	 */
	IProgramElement findElementForSourceFile(String sourceFile);

	/**
	 * TODO: discriminate columns
	 */
	IProgramElement findElementForSourceLine(ISourceLocation location);

	/**
	 * Never returns null
	 *
	 * @param sourceFilePath canonicalized path for consistency
	 * @param lineNumber if 0 or 1 the corresponding file node will be returned
	 * @return a new structure node for the file if it was not found in the model
	 */
	IProgramElement findElementForSourceLine(String sourceFilePath, int lineNumber);

	IProgramElement findElementForOffSet(String sourceFilePath, int lineNumber, int offSet);

	String getConfigFile();

	void setConfigFile(String configFile);

	void flushTypeMap();

	void flushHandleMap();

	void updateHandleMap(Set deletedFiles);

	/**
	 * For a specified node, check if any of the children more accurately represent the specified line.
	 *
	 * @param node where to start looking
	 * @param lineno the line number
	 * @return any closer match below 'node' or null if nothing is a more accurate match
	 */
	IProgramElement findCloserMatchForLineNumber(IProgramElement node, int lineno);

	/**
	 * Discover the node representing a particular source file.
	 *
	 * @param node where in the model to start looking (usually the root on the initial call)
	 * @param sourcefilePath the source file being searched for
	 * @return the node representing that source file or null if it cannot be found
	 */
	IProgramElement findNodeForSourceFile(IProgramElement node, String sourcefilePath);
}