KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > modules > javadoc > search > JavadocSearchEngine


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.modules.javadoc.search;
21
22 /**
23  *
24  * @author Petr Suchomel
25  * @version 0.1
26  */
27 public abstract class JavadocSearchEngine extends java.lang.Object JavaDoc {
28
29     /** Used to search for set elements in javadoc repository
30      * @param callback Callback giving new items and finished event
31      * @param items to search for
32      * @throws NoJavadocException if no javadoc directory is mounted, nothing can be searched
33      */
34     public abstract void search(String JavaDoc[] items, SearchEngineCallback callback) throws NoJavadocException;
35
36     /** Stops execution of Javadoc search thread
37      */
38     public abstract void stop();
39     
40     /** Gets default engine
41      * @return default Javadoc search engine
42      */
43     public static JavadocSearchEngine getDefault(){
44         return new JavadocSearchEngineImpl();
45     }
46     
47     /** Call back interface for Javadoc search engine
48      */
49     public static interface SearchEngineCallback {
50         /**
51          * Called if search process finished
52          */
53         public void finished();
54         
55         /** Called if javadoc item found
56          * @param item DocIndexItem with found data
57          */
58         public void addItem(DocIndexItem item);
59     }
60     
61 }
62
Popular Tags