org.netbeans.spi.java.classpath

Class GlobalPathRegistryImplementation

java.lang.Object

org.netbeans.spi.java.classpath.GlobalPathRegistryImplementation

public abstract class GlobalPathRegistryImplementation
extends Object

The SPI interface for the GlobalPathRegistry. Allows different implementations of the GlobalPathRegistry. The first SPI instance registered in the global Lookup is used by the GlobalPathRegistry. Threading: The implementations don't need to be thread safe, synchronization is done by the GlobalPathRegistry.

Since:

1.48

Constructor Summary

Constructors

Constructor and Description
GlobalPathRegistryImplementation()

Method Summary

Modifier and Type	Method and Description
protected abstract Set<ClassPath>	clear() Removes all known classpaths.
protected abstract Set<ClassPath>	getPaths(String id) Find all paths of a certain type.
protected abstract Set<ClassPath>	register(String id, ClassPath[] paths) Register some classpaths of a certain type.
protected abstract Set<ClassPath>	unregister(String id, ClassPath[] paths) Unregister some classpaths of a certain type.

Methods inherited from class java.lang.Object

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

Constructor Detail

GlobalPathRegistryImplementation

public GlobalPathRegistryImplementation()

Method Detail

getPaths

@NonNull
protected abstract Set<ClassPath> getPaths(@NonNull
                                                    String id)

Find all paths of a certain type.

Parameters:

id - a classpath type, e.g. ClassPath.SOURCE

Returns:

an immutable set of all registered ClassPaths of that type (may be empty but not null)

register

@NonNull
protected abstract Set<ClassPath> register(@NonNull
                                                    String id,
                                                    @NonNull
                                                    ClassPath[] paths)

Register some classpaths of a certain type.

Parameters:

id - a classpath type, e.g. ClassPath.SOURCE

paths - a list of classpaths to add to the registry

Returns:

the added classpaths

unregister

@NonNull
protected abstract Set<ClassPath> unregister(@NonNull
                                                      String id,
                                                      @NonNull
                                                      ClassPath[] paths)
                                               throws IllegalArgumentException

Unregister some classpaths of a certain type.

Parameters:

id - a classpath type, e.g. ClassPath.SOURCE

paths - a list of classpaths to remove from the registry

Returns:

the removed classpaths

Throws:

IllegalArgumentException - if they had not been registered before

clear

@NonNull
protected abstract Set<ClassPath> clear()

Removes all known classpaths.

Returns:

a set of removed classpaths