/*******************************************************************************
* Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.jdt.core.search;
import org.eclipse.jdt.internal.compiler.env.AccessRestriction;
/**
* A TypeNameRequestor
collects search results from a searchAllTypeNames
* query to a SearchEngine
. Clients must subclass this abstract class and pass
* an instance to the searchAllTypeNames(...)
method. Only top-level and
* member types are reported. Local types are not reported.
*
* This class may be subclassed by clients. *
*/ public abstract class TypeNameRequestor { /** * Accepts a top-level or a member type. * * @param modifiers the modifiers of the type. Note that for source type, this modifiers may slightly differ from * resolved one. For example an interface defined byinterface A {}
will have its modifiers
* set to AccInterface but not AccPublic although, after reslution, it will be.
* @param packageName the dot-separated name of the package of the type
* @param simpleTypeName the simple name of the type
* @param enclosingTypeNames if the type is a member type,
* the simple names of the enclosing types from the outer-most to the
* direct parent of the type (for example, if the class is x.y.A$B$C then
* the enclosing types are [A, B]. This is an empty array if the type
* is a top-level type.
* @param path the full path to the resource containing the type. If the resource is a .class file
* or a .java file, this is the full path in the workspace to this resource. If the
* resource is an archive (that is, a .zip or .jar file), the path is composed of 2 paths separated
* by IJavaSearchScope.JAR_FILE_ENTRY_SEPARATOR
:
* the first path is the full OS path to the archive (if it is an external archive),
* or the workspace relative IPath
to the archive (if it is an internal archive),
* the second path is the path to the resource inside the archive.
* @param access the restriction access for the type. null
means no restriction.
*/
public abstract void acceptType(int modifiers, char[] packageName, char[] simpleTypeName, char[][] enclosingTypeNames, String path, AccessRestriction access);
}