01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common
08: * Development and Distribution License("CDDL") (collectively, the
09: * "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-2007 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: package org.netbeans.spi.java.queries;
42:
43: import java.net.URL;
44: import org.netbeans.api.java.queries.BinaryForSourceQuery;
45:
46: /**
47: * Information about where binaries (classfiles) corresponding to
48: * Java sources can be found, this is intended to be the inverse of
49: * the SourceForBinaryQueryImplementation.
50: * @see BinaryForSourceQuery
51: * @see SourceForBinaryQuery
52: * @see SourceForBinaryQueryImplementation
53: * @since org.netbeans.api.java/1 1.12
54: * @author Tomas Zezula
55: */
56: public interface BinaryForSourceQueryImplementation {
57:
58: /**
59: * Returns the binary root(s) for a given source root.
60: * <p>
61: * The returned BinaryForSourceQuery.Result must be a singleton. It means that for
62: * repeated calling of this method with the same recognized root the method has to
63: * return the same instance of BinaryForSourceQuery.Result.<br>
64: * The typical implemantation of the findBinaryRoots contains 3 steps:
65: * <ol>
66: * <li>Look into the cache if there is already a result for the root, if so return it</li>
67: * <li>Check if the sourceRoot is recognized, if not return null</li>
68: * <li>Create a new BinaryForSourceQuery.Result for the sourceRoot, put it into the cache
69: * and return it.</li>
70: * </ol>
71: * </p>
72: * <p>
73: * Any absolute URL may be used but typically it will use the <code>file</code>
74: * protocol for directory entries and <code>jar</code> protocol for JAR entries
75: * (e.g. <samp>jar:file:/tmp/foo.jar!/</samp>).
76: * </p>
77: * @param sourceRoot the source path root
78: * @return a result object encapsulating the answer or null if the sourceRoot is not recognized
79: */
80: public BinaryForSourceQuery.Result findBinaryRoots(URL sourceRoot);
81:
82: }
|