org.netbeans.spi.java.classpath.support

Class ClassPathSupport

java.lang.Object

org.netbeans.spi.java.classpath.support.ClassPathSupport

public class ClassPathSupport
extends Object

Convenience factory for creating classpaths of common sorts.

Since:

org.netbeans.api.java/1 1.4

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ClassPathSupport.Selector The active ClassPath provider for multiplexing ClassPath.

Method Summary

Modifier and Type	Method and Description
static ClassPath	createClassPath(FileObject... roots) Create ClassPath for the given array of class path roots
static ClassPath	createClassPath(List<? extends PathResourceImplementation> entries) Create ClassPath for the given list of PathResourceImplementation entries.
static ClassPath	createClassPath(String jvmPath) Convenience method to create a classpath object from a conventional string representation.
static ClassPath	createClassPath(URL... roots) Create ClassPath for the given array of class path roots
static ClassPathImplementation	createClassPathImplementation(List<? extends PathResourceImplementation> entries) Create ClassPathImplementation for the given list of PathResourceImplementation entries.
static ClassPath	createMultiplexClassPath(ClassPathSupport.Selector selector) Creates a ClassPath switching among several ClassPath instances.
static ClassPath	createProxyClassPath(ClassPath... delegates) Creates read only proxy ClassPath for given delegates.
static ClassPathImplementation	createProxyClassPathImplementation(ClassPathImplementation... delegates) Creates read only proxy ClassPathImplementation for given delegates.
static PathResourceImplementation	createResource(URL url) Creates leaf PathResourceImplementation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createResource

public static PathResourceImplementation createResource(URL url)

Creates leaf PathResourceImplementation. The created PathResourceImplementation has exactly one immutable root.

Parameters:

url - the root of the resource. The URL must refer to folder. In the case of 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:

PathResourceImplementation

createClassPathImplementation

public static ClassPathImplementation createClassPathImplementation(List<? extends PathResourceImplementation> entries)

Create ClassPathImplementation for the given list of PathResourceImplementation entries.

Parameters:

entries - list of PathResourceImplementation instances; cannot be null; can be empty

Returns:

SPI classpath

createClassPath

public static ClassPath createClassPath(List<? extends PathResourceImplementation> entries)

Create ClassPath for the given list of PathResourceImplementation entries.

Parameters:

entries - list of PathResourceImplementation instances; cannot be null; can be empty

Returns:

API classpath

createClassPath

public static ClassPath createClassPath(FileObject... roots)

Create ClassPath for the given array of class path roots

Parameters:

roots - array of fileobjects which must correspond to directory. In the case of archive file, the FileObject representing the root of the archive must be used. Cannot be null; can be empty array; array can contain nulls.

Returns:

API classpath

createClassPath

public static ClassPath createClassPath(URL... roots)

Create ClassPath for the given array of class path roots

Parameters:

roots - array of URLs which must correspond to folder. In the case of 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. Cannot be null; can be empty array; array can contain nulls.

Returns:

API classpath

createClassPath

public static ClassPath createClassPath(String jvmPath)
                                 throws IllegalArgumentException

Convenience method to create a classpath object from a conventional string representation.

Parameters:

jvmPath - a JVM-style classpath (folder or archive paths separated by File.pathSeparator)

Returns:

a corresponding classpath object

Throws:

IllegalArgumentException - in case a path entry looks to be invalid

Since:

org.netbeans.api.java/1 1.15

See Also:

FileUtil.urlForArchiveOrDir(java.io.File), ClassPath#toJVMPath

createProxyClassPathImplementation

public static ClassPathImplementation createProxyClassPathImplementation(ClassPathImplementation... delegates)

Creates read only proxy ClassPathImplementation for given delegates. The order of resources is given by the order of the delegates

Parameters:

delegates - ClassPathImplementations to delegate to.

Returns:

SPI classpath

createProxyClassPath

public static ClassPath createProxyClassPath(ClassPath... delegates)

Creates read only proxy ClassPath for given delegates. The order of resources is given by the order of the delegates

Parameters:

delegates - ClassPaths to delegate to.

Returns:

API classpath

createMultiplexClassPath

@NonNull
public static ClassPath createMultiplexClassPath(@NonNull
                                                          ClassPathSupport.Selector selector)

Creates a ClassPath switching among several ClassPath instances.

Parameters:

selector - the active ClassPath provider

Returns:

a newly created ClassPath instance

Since:

1.54