← Back to branch summary

~ubuntu-branches/ubuntu/quantal/netbeans/quantal

« back to all changes in this revision

Viewing changes to java/api/src/org/netbeans/spi/java/queries/JavadocForBinaryQueryImplementation.java

  • Committer: Bazaar Package Importer
  • Author(s): Marek Slama
  • Date: 2008-01-29 14:11:22 UTC
  • Revision ID: james.westby@ubuntu.com-20080129141122-fnzjbo11ntghxfu7
Tags: upstream-6.0.1
Import upstream version 6.0.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
java/api/src/org/netbeans/spi/java/queries/JavadocForBinaryQueryImplementation.java
 
1
/*
 
2
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 
3
 *
 
4
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 
5
 *
 
6
 * The contents of this file are subject to the terms of either the GNU
 
7
 * General Public License Version 2 only ("GPL") or the Common
 
8
 * Development and Distribution License("CDDL") (collectively, the
 
9
 * "License"). You may not use this file except in compliance with the
 
10
 * License. You can obtain a copy of the License at
 
11
 * http://www.netbeans.org/cddl-gplv2.html
 
12
 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
 
13
 * specific language governing permissions and limitations under the
 
14
 * License.  When distributing the software, include this License Header
 
15
 * Notice in each file and include the License file at
 
16
 * nbbuild/licenses/CDDL-GPL-2-CP.  Sun designates this
 
17
 * particular file as subject to the "Classpath" exception as provided
 
18
 * by Sun in the GPL Version 2 section of the License file that
 
19
 * accompanied this code. If applicable, add the following below the
 
20
 * License Header, with the fields enclosed by brackets [] replaced by
 
21
 * your own identifying information:
 
22
 * "Portions Copyrighted [year] [name of copyright owner]"
 
23
 *
 
24
 * Contributor(s):
 
25
 *
 
26
 * The Original Software is NetBeans. The Initial Developer of the Original
 
27
 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
 
28
 * Microsystems, Inc. All Rights Reserved.
 
29
 *
 
30
 * If you wish your version of this file to be governed by only the CDDL
 
31
 * or only the GPL Version 2, indicate your decision by adding
 
32
 * "[Contributor] elects to include this software in this distribution
 
33
 * under the [CDDL or GPL Version 2] license." If you do not indicate a
 
34
 * single choice of license, a recipient has the option to distribute
 
35
 * your version of this file under either the CDDL, the GPL Version 2 or
 
36
 * to extend the choice of license to its licensees as provided above.
 
37
 * However, if you add GPL Version 2 code and therefore, elected the GPL
 
38
 * Version 2 license, then the option applies only if the new code is
 
39
 * made subject to such option by the copyright holder.
 
40
 */
 
41
 
 
42
package org.netbeans.spi.java.queries;
 
43
 
 
44
import java.net.URL;
 
45
import org.netbeans.api.java.queries.JavadocForBinaryQuery;
 
46
 
 
47
/**
 
48
 * A query to find Javadoc root for the given classpath root.
 
49
 * <p>A default implementation is registered by the
 
50
 * <code>org.netbeans.modules.java.project</code> module which looks up the
 
51
 * project corresponding to the binary file and checks whether that
 
52
 * project has an implementation of this interface in its lookup. If so, it
 
53
 * delegates to that implementation. Therefore it is not generally necessary
 
54
 * for a project type provider to register its own global implementation of
 
55
 * this query, if it depends on the Java Project module and uses this style.
 
56
 * </p>
 
57
 * @see JavadocForBinaryQuery
 
58
 * @see org.netbeans.api.project.Project#getLookup
 
59
 * @author David Konecny, Jesse Glick
 
60
 * @since org.netbeans.api.java/1 1.4
 
61
 */
 
62
public interface JavadocForBinaryQueryImplementation {
 
63
    
 
64
    /**
 
65
     * Find any Javadoc corresponding to the given classpath root containing
 
66
     * Java classes.
 
67
     * <p>
 
68
     * Any absolute URL may be used but typically it will use the <code>file</code>
 
69
     * protocol for directory entries and <code>jar</code> protocol for JAR entries
 
70
     * (e.g. <samp>jar:file:/tmp/foo.jar!/</samp>).
 
71
     * </p>
 
72
     * <p>
 
73
     * {@link JavadocForBinaryQuery#findJavadoc} calls this method on instances registered
 
74
     * in default lookup until a non-null result is returned for the given binaryRoot.
 
75
     * </p>
 
76
     * @param binaryRoot the class path root of Java class files
 
77
     * @return a result object encapsulating the roots and permitting changes to
 
78
     *         be listened to, or null if the binary root is not recognized
 
79
     */
 
80
    JavadocForBinaryQuery.Result findJavadoc(URL binaryRoot);
 
81
    
 
82
}