apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/IApiScope.java

/*******************************************************************************
 * Copyright (c) 2008, 2009 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.eclipse.pde.api.tools.internal.provisional.model;

import org.eclipse.core.runtime.CoreException;

/**
 * Describes a set of {@link IApiElement}.
 *
 * @since 1.1.0
 */
public interface IApiScope {

	/**
	 * Adds the given {@link IApiElement} to the scope
	 *
	 * @param newelements
	 */
	public void addElement(IApiElement newelement);

	/**
	 * Returns all API elements contained within this scope
	 *
	 * @return all API elements contained within this scope
	 */
	IApiElement[] getApiElements();

	/**
	 * Visits all {@link IApiElement} in this scope.
	 *
	 * @param visitor class file visitor.
	 * @exception CoreException if unable to visit this scope
	 */
	void accept(ApiScopeVisitor visitor) throws CoreException;

	/**
	 * Returns if this scope encloses the given element
	 *
	 * @param element
	 * @return true if this scope encloses the given element, false otherwise
	 */
	public boolean encloses(IApiElement element) throws CoreException;
}