Package com.intellij.compiler.impl

Class CompositeScope

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.openapi.compiler.ExportableUserDataHolderBase

com.intellij.compiler.impl.CompositeScope

All Implemented Interfaces:

CompileScope, ExportableUserDataHolder, UserDataHolder, UserDataHolderEx

public class CompositeScope
extends ExportableUserDataHolderBase
implements CompileScope

Field Summary

Fields inherited from interface com.intellij.openapi.compiler.CompileScope

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
CompositeScope(CompileScope [] scopes)
CompositeScope(CompileScope scope1, CompileScope scope2)

Method Summary

Modifier and Type	Method and Description
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.
java.util.Collection<ModuleSourceSet>	getAffectedSourceSets()
java.util.Collection<java.lang.String>	getAffectedUnloadedModules()
VirtualFile []	getFiles(FileType fileType, boolean inSourceOnly) Returns the list of files within the scope.
java.util.Collection<CompileScope>	getScopes()
<T> T	getUserData(Key<T> key)

Methods inherited from class com.intellij.openapi.compiler.ExportableUserDataHolderBase

exportUserData

Methods inherited from class com.intellij.openapi.util.UserDataHolderBase

changeUserMap, clearUserData, clone, copyCopyableDataTo, copyUserDataTo, getCopyableUserData, getUserDataString, getUserMap, isUserDataEmpty, putCopyableUserData, putUserData, putUserDataIfAbsent, replace, setUserMap

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.openapi.compiler.ExportableUserDataHolder

exportUserData

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

putUserData

Constructor Detail

CompositeScope

public CompositeScope(CompileScope scope1,
                      CompileScope scope2)

CompositeScope

public CompositeScope(CompileScope [] scopes)

Method Detail

getFiles

public VirtualFile [] getFiles(FileType fileType,
                               boolean inSourceOnly)

Description copied from interface: CompileScope

Returns the list of files within the scope.

Specified by:

getFiles in interface CompileScope

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

public boolean belongs(java.lang.String url)

Description copied from interface: CompileScope

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

Specified by:

belongs in interface CompileScope

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

public Module [] getAffectedModules()

Description copied from interface: CompileScope

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

Specified by:

getAffectedModules in interface CompileScope

Returns:

a list of modules this scope affects.

getAffectedSourceSets

public java.util.Collection<ModuleSourceSet> getAffectedSourceSets()

Specified by:

getAffectedSourceSets in interface CompileScope

Returns:

similar to {getAffectedModules}, but is more precise about which kinds of source roots are affected: production and/or tests

getAffectedUnloadedModules

public java.util.Collection<java.lang.String> getAffectedUnloadedModules()

Specified by:

getAffectedUnloadedModules in interface CompileScope

Returns:

list of names of unloaded modules this scope affects.

getUserData

public <T> T getUserData(Key<T> key)

Specified by:

getUserData in interface UserDataHolder

Overrides:

getUserData in class UserDataHolderBase

Returns:

a user data value associated with this object. Doesn't require read action.

getScopes

public java.util.Collection<CompileScope> getScopes()