Indexer


1   /*
2    * The contents of this file are subject to the terms of the Common Development
3    * and Distribution License (the License). You may not use this file except in
4    * compliance with the License.
5    *
6    * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7    * or http://www.netbeans.org/cddl.txt.
8    *
9    * When distributing Covered Code, include this CDDL Header Notice in each file
10   * and include the License file at http://www.netbeans.org/cddl.txt.
11   * If applicable, add the following below the CDDL Header, with the fields
12   * enclosed by brackets [] replaced by your own identifying information:
13   * "Portions Copyrighted [year] [name of copyright owner]"
14   *
15   * The Original Software is NetBeans. The Initial Developer of the Original
16   * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17   * Microsystems, Inc. All Rights Reserved.
18   */
19  
20  package org.netbeans.api.gsf;
21  
22  import java.io.IOException  ;
23  import org.netbeans.api.gsf.ParserResult;
24  
25  /**
26   * Language plugins should implement this interface and register the
27   * implementation in the Languages folder. This method will be called
28   * when the index needs to be updated. The indexer should iterate through
29   * its parsing results and store information in the provided index as
30   * necessary. Client code like code completion etc. can later retrieve
31   * information from the index which is passed around with CompilationInfos.
32   * 
33   * @author Tor Norbye
34   */
35  public abstract interface Indexer {
36      /** Returns true iff this indexer wants to index the given file */
37      boolean isIndexable(ParserFile file);
38      
39      /** For files that are {@link #isIndexable}, index the given file by
40       * operating on the provided {@link Index} using the given {@link ParserResult} to
41       * fetch AST information. 
42       */
43      void updateIndex(Index index,  ParserResult result) throws IOException  ;
44      
45  }
46
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags