Cleaned up PHP Prefs (Code Assist, Typing)
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpdt / internal / codeassist / ISearchRequestor.java
1 /*******************************************************************************
2  * Copyright (c) 2000, 2003 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials 
4  * are made available under the terms of the Common Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/cpl-v10.html
7  * 
8  * Contributors:
9  *     IBM Corporation - initial API and implementation
10  *******************************************************************************/
11 package net.sourceforge.phpdt.internal.codeassist;
12
13 /**
14  * This is the internal requestor passed to the searchable name environment
15  * so as to process the multiple search results as they are discovered.
16  *
17  * It is used to allow the code assist engine to add some more information
18  * to the raw name environment results before answering them to the UI.
19  */
20 public interface ISearchRequestor {
21         
22         /**
23          * One result of the search consists of a new class.
24          *
25          * NOTE - All package and type names are presented in their readable form:
26          *    Package names are in the form "a.b.c".
27          *    Nested type names are in the qualified form "A.M".
28          *    The default package is represented by an empty array.
29          */
30         public void acceptClass(char[] packageName, char[] typeName, int modifiers);
31
32         /**
33          * One result of the search consists of a new interface.
34          *
35          * NOTE - All package and type names are presented in their readable form:
36          *    Package names are in the form "a.b.c".
37          *    Nested type names are in the qualified form "A.I".
38          *    The default package is represented by an empty array.
39          */
40         public void acceptInterface(char[] packageName, char[] typeName, int modifiers);
41
42         /**
43          * One result of the search consists of a new package.
44          *
45          * NOTE - All package names are presented in their readable form:
46          *    Package names are in the form "a.b.c".
47          *    The default package is represented by an empty array.
48          */
49         public void acceptPackage(char[] packageName);
50
51         /**
52          * One result of the search consists of a new type.
53          *
54          * NOTE - All package and type names are presented in their readable form:
55          *    Package names are in the form "a.b.c".
56          *    Nested type names are in the qualified form "A.M".
57          *    The default package is represented by an empty array.
58          */
59         public void acceptType(char[] packageName, char[] typeName);
60 }