What this is
This file is included in the DevDaily.com
"Java Source Code
Warehouse" project. The intent of this project is to help you "Learn
Java by Example" TM.
Other links
The source code
/*
* Sun Public License Notice
*
* The contents of this file are subject to the Sun Public License
* Version 1.0 (the "License"). You may not use this file except in
* compliance with the License. A copy of the License is available at
* http://www.sun.com/
*
* The Original Code is NetBeans. The Initial Developer of the Original
* Code is Sun Microsystems, Inc. Portions Copyright 1997-2004 Sun
* Microsystems, Inc. All Rights Reserved.
*/
package org.netbeans.spi.java.queries;
import java.net.URL;
import org.netbeans.api.java.queries.JavadocForBinaryQuery;
/**
* A query to find Javadoc root for the given classpath root.
* A default implementation is registered by the
* org.netbeans.modules.java.project module which looks up the
* project corresponding to the binary file and checks whether that
* project has an implementation of this interface in its lookup. If so, it
* delegates to that implementation. Therefore it is not generally necessary
* for a project type provider to register its own global implementation of
* this query, if it depends on the Java Project module and uses this style.
*
* @see JavadocForBinaryQuery
* @see org.netbeans.api.project.Project#getLookup
* @author David Konecny, Jesse Glick
* @since org.netbeans.api.java/1 1.4
*/
public interface JavadocForBinaryQueryImplementation {
/**
* Find any Javadoc corresponding to the given classpath root containing
* Java classes.
*
* Any absolute URL may be used but typically it will use the file
* protocol for directory entries and jar protocol for JAR entries
* (e.g. jar:file:/tmp/foo.jar!/).
*
*
* The JavadocForBinaryQuery class calls this method on instances registered
* in the lookup until null result is returned for given binaryRoot. The
* non null result is returned by the JavadocForBinaryQuery.findJavadoc method.
*
* @param binaryRoot the class path root of Java class files
* @return a result object encapsulating the roots and permitting changes to
* be listened to, or null if the binary root is not recognized
*/
JavadocForBinaryQuery.Result findJavadoc(URL binaryRoot);
}
|