core/plugins/org.eclipse.dltk.core/search/org/eclipse/dltk/core/search/MethodNameRequestor.java

/*******************************************************************************
 * Copyright (c) 2000, 2007 IBM Corporation and others.
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 * 
 * SPDX-License-Identifier: EPL-2.0
 *
 
 *******************************************************************************/
package org.eclipse.dltk.core.search;

/**
 * A <code>MethodNameRequestor</code> collects search results from a
 * <code>searchAllTypeNames</code> query to a <code>SearchEngine</code>. Clients
 * must subclass this abstract class and pass an instance to the
 * <code>SearchEngine.searchAllTypeNames(...)</code> method. Only top-level and
 * member types are reported. Local types are not reported.
 * <p>
 * This class may be subclassed by clients.
 * </p>
 * 
 */
public abstract class MethodNameRequestor {
	/**
	 * Accepts a top-level or a member type.
	 * <p>
	 * The default implementation of this method does nothing. Subclasses should
	 * override.
	 * </p>
	 * 
	 * @param modifiers
	 *            the modifier flags of the type. Note that for source type,
	 *            these flags may slightly differ from thoses get after
	 *            resolution. For example an interface defined by
	 *            <code>interface A {}</code>, although obviously public, will
	 *            be returned false by <code>Flags.isPublic(modifiers)</code>
	 *            due to the fact that its declaration does not explicitely
	 *            define public flag.
	 * @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 parameterNames
	 *            Method parameter names.
	 * @param path
	 *            the full path to the resource containing the type. If the
	 *            resource is a .class file or a source file, this is the full
	 *            path in the workspace to this resource. If the resource is an
	 *            archive (that is, a .zip file), the path is composed of 2
	 *            paths separated by
	 *            <code>IDLTKSearchScope.ARCHIVE_FILE_ENTRY_SEPARATOR</code>:
	 *            the first path is the full OS path to the archive (if it is an
	 *            external archive), or the workspace relative
	 *            <code>IPath</code> to the archive (if it is an internal
	 *            archive), the second path is the path to the resource inside
	 *            the archive.
	 */
	public void acceptMethod(int modifiers, char[] packageName,
			char[] simpleMethodName, char[][] enclosingTypeNames,
			char[][] parameterNames, String path) {
		// do nothing
	}
}