Package com.intellij.openapi.roots

Class AdditionalLibraryRootsProvider

java.lang.Object

com.intellij.openapi.roots.AdditionalLibraryRootsProvider

public abstract class AdditionalLibraryRootsProvider
extends java.lang.Object

Implement this EP to provide additional library roots. It can be useful when it's undesirable to create Library and attach it to a module via OrderEntry. Additional library roots will extend GlobalSearchScope.allScope(Project) (in UI, "Project and Libraries" scope). Also, files contained in the roots will be shown as library files in Project View and will be available in "Navigate | File..." popup.

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<AdditionalLibraryRootsProvider>	EP_NAME

Constructor Summary

Constructors

Constructor and Description
AdditionalLibraryRootsProvider()

Method Summary

Modifier and Type	Method and Description
java.util.Collection<SyntheticLibrary>	getAdditionalProjectLibraries(Project project) Returns a collection of SyntheticLibrary.
java.util.Collection<VirtualFile>	getRootsToWatch(Project project) The method returns roots that IDE should use to track external changes.

Methods inherited from class java.lang.Object

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

Field Detail

EP_NAME

public static final ExtensionPointName<AdditionalLibraryRootsProvider> EP_NAME

Constructor Detail

AdditionalLibraryRootsProvider

public AdditionalLibraryRootsProvider()

Method Detail

getAdditionalProjectLibraries

public java.util.Collection<SyntheticLibrary> getAdditionalProjectLibraries(Project project)

Returns a collection of SyntheticLibrary. This method is suitable when it's easier to collect all additional library roots associated with Project, instead of Module. E.g. JavaScript libraries can be associated with files or folders allowing more fine-grained control.

Parameters:

project - Project instance

Returns:

a collection of SyntheticLibrary

getRootsToWatch

public java.util.Collection<VirtualFile> getRootsToWatch(Project project)

The method returns roots that IDE should use to track external changes. If the provider retrieves libraries that have mutable source roots, it makes sense return them as Watched Roots as well. Essentially, the method is a shortcut for WatchedRootsProvider. CAUTION! Each root provided by this method makes VFS update slower. Please, avoid returning a lot of watched roots, especially if they have complicated internal structure.

Parameters:

project - Project instance

See Also:

WatchedRootsProvider