com.intellij.openapi.compiler
Interface CompileScope

All Superinterfaces:

UserDataHolder

public interface CompileScope
extends UserDataHolder

Interface describing the current compilation scope. Only sources that belong to the scope are compiled.

See Also:

CompilerManager.compile(CompileScope, CompileStatusNotification, boolean)

Method Summary

boolean	belongs(java.lang.String url) Checks if the file with the specified URL belongs to the scope.
Module[]	getAffectedModules() Returns the list of modules files in which belong to the scope.
VirtualFile[]	getFiles(FileType fileType, boolean inSourceOnly) Returns the list of files within the scope.

Methods inherited from interface com.intellij.openapi.util.UserDataHolder

getUserData, putUserData

Method Detail

getFiles

VirtualFile[] getFiles(@Nullable
                       FileType fileType,
                       boolean inSourceOnly)

Returns the list of files within the scope.

Parameters:

fileType - the type of the files. Null should be passed if all available files are needed.

inSourceOnly - if true, files are searched only in directories within the scope that are marked as "sources" or "test sources" in module settings. Otherwise files are searched in all directories that belong to the scope.

Returns:

a list of files of given type that belong to this scope.

belongs

boolean belongs(java.lang.String url)

Checks if the file with the specified URL belongs to the scope.

Parameters:

url - an VFS url. Note that actual file may not exist on the disk.

Returns:

true if the url specified belongs to the scope, false otherwise. Note: the method may be time-consuming.

getAffectedModules

Module[] getAffectedModules()

Returns the list of modules files in which belong to the scope.

Returns:

a list of modules this scope affects.