org.netbeans.modules.java.api.common.classpath

Class AbstractClassPathProvider

java.lang.Object

org.netbeans.modules.java.api.common.classpath.AbstractClassPathProvider

All Implemented Interfaces:

ClassPathProvider

Direct Known Subclasses:

ClassPathProviderImpl, MultiModuleClassPathProvider

public abstract class AbstractClassPathProvider
extends Object
implements ClassPathProvider

The base class for implementation of ClassPathProvider.

Since:

1.99

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractClassPathProvider.ClassPathsChangeEvent The event describing a change of project's ClassPath set.
static interface	AbstractClassPathProvider.ClassPathsChangeListener Event listener interface for being notified of changes in the set of projects paths.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractClassPathProvider() Initializes the AbstractClassPathProvider.

Method Summary

Modifier and Type	Method and Description
void	addClassPathsChangeListener(AbstractClassPathProvider.ClassPathsChangeListener listener) Adds the AbstractClassPathProvider.ClassPathsChangeListener.
protected void	fireClassPathsChange(Collection<? extends String> changedClassPathTypes) Fires the project's ClassPaths change.
abstract ClassPath[]	getProjectClassPaths(String type) Returns ClassPaths of given type owned by the project.
abstract String[]	getPropertyName(SourceGroup sg, String type) Returns the names of path properties storing the path type for given SourceGroup.
void	removeClassPathsChangeListener(AbstractClassPathProvider.ClassPathsChangeListener listener) Removes the AbstractClassPathProvider.ClassPathsChangeListener.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.netbeans.spi.java.classpath.ClassPathProvider

findClassPath

Constructor Detail

AbstractClassPathProvider

protected AbstractClassPathProvider()

Initializes the AbstractClassPathProvider.

Method Detail

getProjectClassPaths

@CheckForNull
public abstract ClassPath[] getProjectClassPaths(@NonNull
                                                               String type)

Returns ClassPaths of given type owned by the project.

Parameters:

type - the ClassPath type

Returns:

the project's ClassPaths

getPropertyName

@CheckForNull
public abstract String[] getPropertyName(@NonNull
                                                       SourceGroup sg,
                                                       @NonNull
                                                       String type)

Returns the names of path properties storing the path type for given SourceGroup.

Parameters:

sg - the SourceGroup to return the properties for

type - the ClassPath type

Returns:

the property names or null when the type is not supported or given SourceGroup is unknown.

Since:

1.113

addClassPathsChangeListener

public final void addClassPathsChangeListener(@NonNull
                                              AbstractClassPathProvider.ClassPathsChangeListener listener)

Adds the AbstractClassPathProvider.ClassPathsChangeListener. The AbstractClassPathProvider.ClassPathsChangeListener is notified when a set of project ClassPaths is changed.

Parameters:

listener - the listener to add.

removeClassPathsChangeListener

public final void removeClassPathsChangeListener(@NonNull
                                                 AbstractClassPathProvider.ClassPathsChangeListener listener)

Removes the AbstractClassPathProvider.ClassPathsChangeListener.

Parameters:

listener - the listener to remove.

fireClassPathsChange

protected final void fireClassPathsChange(@NonNull
                                          Collection<? extends String> changedClassPathTypes)

Fires the project's ClassPaths change.

Parameters:

changedClassPathTypes - the changed ClassPath types