KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > spi > java > queries > JavadocForBinaryQueryImplementation


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.spi.java.queries;
21
22 import java.net.URL JavaDoc;
23 import org.netbeans.api.java.queries.JavadocForBinaryQuery;
24
25 /**
26  * A query to find Javadoc root for the given classpath root.
27  * <p>A default implementation is registered by the
28  * <code>org.netbeans.modules.java.project</code> module which looks up the
29  * project corresponding to the binary file and checks whether that
30  * project has an implementation of this interface in its lookup. If so, it
31  * delegates to that implementation. Therefore it is not generally necessary
32  * for a project type provider to register its own global implementation of
33  * this query, if it depends on the Java Project module and uses this style.
34  * </p>
35  * @see JavadocForBinaryQuery
36  * @see org.netbeans.api.project.Project#getLookup
37  * @author David Konecny, Jesse Glick
38  * @since org.netbeans.api.java/1 1.4
39  */
40 public interface JavadocForBinaryQueryImplementation {
41     
42     /**
43      * Find any Javadoc corresponding to the given classpath root containing
44      * Java classes.
45      * <p>
46      * Any absolute URL may be used but typically it will use the <code>file</code>
47      * protocol for directory entries and <code>jar</code> protocol for JAR entries
48      * (e.g. <samp>jar:file:/tmp/foo.jar!/</samp>).
49      * </p>
50      * <p>
51      * {@link JavadocForBinaryQuery#findJavadoc} calls this method on instances registered
52      * in default lookup until a non-null result is returned for the given binaryRoot.
53      * </p>
54      * @param binaryRoot the class path root of Java class files
55      * @return a result object encapsulating the roots and permitting changes to
56      * be listened to, or null if the binary root is not recognized
57      */
58     JavadocForBinaryQuery.Result findJavadoc(URL JavaDoc binaryRoot);
59     
60 }
61
Popular Tags