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-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: package org.netbeans.modules.gsfpath.spi.queries;
42:
43: import java.net.URL;
44: import org.openide.filesystems.FileObject;
45:
46: /**
47: * Query to find Java package roots of unit tests for Java package root of
48: * sources and vice versa.
49: *
50: * <p>A default implementation is registered by the
51: * <code>org.netbeans.modules.gsfpath.project</code> module which looks up the
52: * project corresponding to the binary file and checks whether that
53: * project has an implementation of this interface in its lookup. If so, it
54: * delegates to that implementation. Therefore it is not generally necessary
55: * for a project type provider to register its own global implementation of
56: * this query, if it depends on the Java Project module and uses this style.</p>
57: *
58: * <p>This interface assumes following mapping pattern between source
59: * files and unit tests: <code>*.java -> *Test.java</code>. This mapping
60: * is used for example for unit test generation and for searching test for
61: * source. Usage of any other pattern will break this functionality.</p>
62: *
63: * @see <a href="@PROJECTS/PROJECTAPI/org/netbeans/api/project/Project.html#getLookup"><code>Project.getLookup()</code></a>
64: * @see org.netbeans.modules.gsfpath.api.queries.UnitTestForSourceQuery
65: * @author Tomas Zezula
66: * @since org.netbeans.modules.gsfpath.api/1 1.7
67: */
68: public interface MultipleRootsUnitTestForSourceQueryImplementation {
69:
70: /**
71: * Returns the test roots for a given source root.
72: *
73: * @param source a Java package root with sources
74: * @return a corresponding Java package roots with unit tests. The
75: * returned URLs need not point to an existing folder. It can be null
76: * when no mapping from source to unit test is known.
77: */
78: public URL[] findUnitTests(FileObject source);
79:
80: /**
81: * Returns the source roots for a given test root.
82: *
83: * @param unitTest a Java package roots with unit tests
84: * @return a corresponding Java package roots with sources. It can be null
85: * when no mapping from unit test to source is known.
86: */
87: public URL[] findSources(FileObject unitTest);
88:
89: }
|