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 so
  15  * 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 to
  18  * 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". Nested type names are in the
  27          * qualified form "A.M". The default package is represented by an empty
  28          * 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". Nested type names are in the
  37          * qualified form "A.I". The default package is represented by an empty
  38          * array.
  39          */
  40         public void acceptInterface(char[] packageName, char[] typeName,
  41                         int modifiers);
  42
  43         /**
  44          * One result of the search consists of a new package.
  45          *
  46          * NOTE - All package names are presented in their readable form: Package
  47          * names are in the form "a.b.c". The default package is represented by an
  48          * empty array.
  49          */
  50         public void acceptPackage(char[] packageName);
  51
  52         /**
  53          * One result of the search consists of a new type.
  54          *
  55          * NOTE - All package and type names are presented in their readable form:
  56          * Package names are in the form "a.b.c". Nested type names are in the
  57          * qualified form "A.M". The default package is represented by an empty
  58          * array.
  59          */
  60         public void acceptType(char[] packageName, char[] typeName);
  61 }