Package com.intellij.openapi.roots

Interface OrderRootsEnumerator

public interface OrderRootsEnumerator

Interface for processing roots of OrderEntry's from OrderEnumerator.

See Also:

OrderEnumerator.classes(), OrderEnumerator.sources()

Method Summary

Modifier and Type	Method and Description
void	collectPaths(PathsList list) Add all source roots processed by this enumerator to list
PathsList	getPathsList()
VirtualFile []	getRoots()
java.lang.String []	getUrls()
OrderRootsEnumerator	usingCache() If roots for this enumerator are already evaluated the cached result will be used.
OrderRootsEnumerator	usingCustomRootProvider(NotNullFunction<? super OrderEntry,VirtualFile[]> provider) Use provider to obtain roots of an library or jdk order entry instead of OrderEntry.getFiles(OrderRootType) method.
OrderRootsEnumerator	withoutSelfModuleOutput() This method makes sense only when dependencies of a module are processed (i.e.

Method Detail

getRoots

VirtualFile [] getRoots()

Returns:

all roots processed by this enumerator

getUrls

java.lang.String [] getUrls()

Returns:

urls of all roots processed by this enumerator

getPathsList

PathsList getPathsList()

Returns:

list of path to all roots processed by this enumerator

collectPaths

void collectPaths(PathsList list)

Add all source roots processed by this enumerator to list

Parameters:

list - list

usingCache

OrderRootsEnumerator usingCache()

If roots for this enumerator are already evaluated the cached result will be used. Otherwise roots will be evaluated and cached for subsequent calls.

Caching is not supported if OrderEnumerator.satisfying(com.intellij.openapi.util.Condition<? super com.intellij.openapi.roots.OrderEntry>), OrderEnumerator.using(com.intellij.openapi.roots.RootModelProvider) or usingCustomRootProvider(com.intellij.util.NotNullFunction<? super com.intellij.openapi.roots.OrderEntry, com.intellij.openapi.vfs.VirtualFile[]>) option is used

Returns:

this instance

withoutSelfModuleOutput

OrderRootsEnumerator withoutSelfModuleOutput()

This method makes sense only when dependencies of a module are processed (i.e. the enumerator instance is obtained by using OrderEnumerator.orderEntries(com.intellij.openapi.module.Module) or ModuleRootModel.orderEntries()). It instructs the enumerator to skip the output of the main module (if OrderEnumerator.productionOnly() option is not specified then only the test output will be skipped)

Returns:

this instance

usingCustomRootProvider

OrderRootsEnumerator usingCustomRootProvider(NotNullFunction<? super OrderEntry,VirtualFile[]> provider)

Use provider to obtain roots of an library or jdk order entry instead of OrderEntry.getFiles(OrderRootType) method. Note that this option won't affect result of getUrls() method

Parameters:

provider - function to evaluate roots for an order entry

Returns:

this instance