org.netbeans.api.java.classpath/1 1.29.1

org.netbeans.api.java.queries
Class SourceForBinaryQuery

java.lang.Object
  extended by org.netbeans.api.java.queries.SourceForBinaryQuery

public class SourceForBinaryQuery
extends Object

The query is used for finding sources for binaries. The examples of usage of this query are:

Since:
org.netbeans.api.java/1 1.4
See Also:
SourceForBinaryQueryImplementation

Nested Class Summary
static interface SourceForBinaryQuery.Result
          Result of finding sources, encapsulating the answer as well as the ability to listen to it.
static class SourceForBinaryQuery.Result2
          Result of finding sources, encapsulating the answer as well as the ability to listen to it.
 
Method Summary
static SourceForBinaryQuery.Result findSourceRoots(URL binaryRoot)
          Returns the source root for given binary root (for example, src folder for jar file or build folder).
static SourceForBinaryQuery.Result2 findSourceRoots2(URL binaryRoot)
          Returns the source root for given binary root (for example, src folder for jar file or build folder).
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

findSourceRoots

public static SourceForBinaryQuery.Result findSourceRoots(URL binaryRoot)
Returns the source root for given binary root (for example, src folder for jar file or build folder).

Parameters:
binaryRoot - the ClassPath root of compiled files. The root URL must refer to folder. In the case of an archive file the jar protocol URL must be used. The folder URL has to end with '/' The FileUtil.urlForArchiveOrDir(java.io.File) can be used to create folder URLs.
Returns:
a result object encapsulating the answer (never null)

findSourceRoots2

public static SourceForBinaryQuery.Result2 findSourceRoots2(URL binaryRoot)
Returns the source root for given binary root (for example, src folder for jar file or build folder). In addition to the original findSourceRoots(java.net.URL) it provides information if the source root(s) should be preferred over the binaries used by the java infrastructure. Most of the clients don't need this information, so thay can use the original findSourceRoots(java.net.URL) method.

Parameters:
binaryRoot - the ClassPath root of compiled files. The root URL must refer to folder. In the case of an archive file the jar protocol URL must be used. The folder URL has to end with '/' The FileUtil.urlForArchiveOrDir(java.io.File) can be used to create folder URLs.
Returns:
a result object encapsulating the answer (never null)
Since:
1.15

org.netbeans.api.java.classpath/1 1.29.1

Built on December 5 2011.  |  Portions Copyright 1997-2011 Sun Microsystems, Inc. All rights reserved.