Package com.intellij.openapi.roots.impl

Class ModuleFileIndexImpl

java.lang.Object

com.intellij.openapi.roots.impl.ModuleFileIndexImpl

All Implemented Interfaces:

FileIndex, ModuleFileIndex

public class ModuleFileIndexImpl
extends java.lang.Object
implements ModuleFileIndex

Constructor Summary

Constructors

Constructor and Description
ModuleFileIndexImpl(Module module)

Method Summary

Modifier and Type	Method and Description
static OrderEntry	findOrderEntryWithOwnerModule(Module ownerModule, java.util.List<? extends OrderEntry> orderEntries)
DirectoryInfo	getInfoForFileOrDirectory(VirtualFile file)
java.util.List<OrderEntry>	getOrderEntriesForFile(VirtualFile fileOrDir) Returns the list of all order entries to which the specified file or directory belongs.
OrderEntry	getOrderEntryForFile(VirtualFile fileOrDir) Returns the order entry to which the specified file or directory belongs.
boolean	isContentSourceFile(VirtualFile file)
boolean	isInContent(VirtualFile fileOrDir) Returns true if fileOrDir is a file or directory under a content root of this project or module and not excluded or ignored.
protected boolean	isInContent(VirtualFile file, DirectoryInfo info)
boolean	isInSourceContent(VirtualFile fileOrDir) Returns true if fileOrDir is a file or directory located under a sources, tests or resources root and not excluded or ignored.
boolean	isInTestSourceContent(VirtualFile fileOrDir) Returns true if fileOrDir is a file or directory located under a test sources or resources root and not excluded or ignored.
protected boolean	isScopeDisposed()
boolean	isUnderSourceRootOfType(VirtualFile fileOrDir, java.util.Set<? extends JpsModuleSourceRootType<?>> rootTypes) Returns true if fileOrDir is a file or directory located under a source root of type from rootTypes set and not excluded or ignored
boolean	iterateContent(ContentIterator processor) Processes all files and directories under content roots skipping excluded and ignored files and directories.
boolean	iterateContent(ContentIterator processor, VirtualFileFilter filter) Same as FileIndex.iterateContent(ContentIterator) but allows to pass filter to provide filtering in condition for directories.
boolean	iterateContentUnderDirectory(VirtualFile dir, ContentIterator processor) Processes all files and directories in the content under directory dir (including the directory itself) skipping excluded and ignored files and directories.
boolean	iterateContentUnderDirectory(VirtualFile dir, ContentIterator processor, VirtualFileFilter customFilter) Same as FileIndex.iterateContentUnderDirectory(VirtualFile, ContentIterator) but allows to pass additional customFilter to the iterator, in case you need to skip some file system branches using your own logic.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.openapi.roots.FileIndex

isContentSourceFile, iterateContent, iterateContentUnderDirectory, iterateContentUnderDirectory

Constructor Detail

ModuleFileIndexImpl

public ModuleFileIndexImpl(Module module)

Method Detail

iterateContent

public boolean iterateContent(ContentIterator processor,
                              VirtualFileFilter filter)

Description copied from interface: FileIndex

Same as FileIndex.iterateContent(ContentIterator) but allows to pass filter to provide filtering in condition for directories.

If filter returns false on a directory, the directory won't be processed, but iteration will go on.

null filter means that all directories should be processed.

Specified by:

iterateContent in interface FileIndex

Returns:

false if files processing was stopped (ContentIterator.processFile(VirtualFile) returned false)

isInContent

public boolean isInContent(VirtualFile fileOrDir)

Description copied from interface: FileIndex

Returns true if fileOrDir is a file or directory under a content root of this project or module and not excluded or ignored.

Specified by:

isInContent in interface FileIndex

isInSourceContent

public boolean isInSourceContent(VirtualFile fileOrDir)

Description copied from interface: FileIndex

Returns true if fileOrDir is a file or directory located under a sources, tests or resources root and not excluded or ignored.

Specified by:

isInSourceContent in interface FileIndex

getOrderEntriesForFile

public java.util.List<OrderEntry> getOrderEntriesForFile(VirtualFile fileOrDir)

Description copied from interface: ModuleFileIndex

Returns the list of all order entries to which the specified file or directory belongs.

Specified by:

getOrderEntriesForFile in interface ModuleFileIndex

Parameters:

fileOrDir - the file or directory to check.

Returns:

the list of order entries to which the file or directory belongs.

getOrderEntryForFile

public OrderEntry getOrderEntryForFile(VirtualFile fileOrDir)

Description copied from interface: ModuleFileIndex

Returns the order entry to which the specified file or directory belongs.

Specified by:

getOrderEntryForFile in interface ModuleFileIndex

Parameters:

fileOrDir - the file or directory to check.

Returns:

the order entry to which the file or directory belongs, or null if it does not belong to any order entry.

isInTestSourceContent

public boolean isInTestSourceContent(VirtualFile fileOrDir)

Description copied from interface: FileIndex

Returns true if fileOrDir is a file or directory located under a test sources or resources root and not excluded or ignored.

Use this method when you really need to check whether the file is under test roots according to project configuration.

If you want to determine whether file should be considered as test (e.g. for implementing SearchScope) you'd better use TestSourcesFilter.isTestSources(VirtualFile, Project) instead which includes FileIndex.isInTestSourceContent(VirtualFile) invocation.

Specified by:

isInTestSourceContent in interface FileIndex

See Also:

TestSourcesFilter.isTestSources(VirtualFile, Project)

isUnderSourceRootOfType

public boolean isUnderSourceRootOfType(VirtualFile fileOrDir,
                                       java.util.Set<? extends JpsModuleSourceRootType<?>> rootTypes)

Description copied from interface: FileIndex

Returns true if fileOrDir is a file or directory located under a source root of type from rootTypes set and not excluded or ignored

Specified by:

isUnderSourceRootOfType in interface FileIndex

isScopeDisposed

protected boolean isScopeDisposed()

findOrderEntryWithOwnerModule

public static OrderEntry findOrderEntryWithOwnerModule(Module ownerModule,
                                                       java.util.List<? extends OrderEntry> orderEntries)

isInContent

protected boolean isInContent(VirtualFile file,
                              DirectoryInfo info)

iterateContent

public boolean iterateContent(ContentIterator processor)

Description copied from interface: FileIndex

Processes all files and directories under content roots skipping excluded and ignored files and directories.

Specified by:

iterateContent in interface FileIndex

Returns:

false if files processing was stopped (ContentIterator.processFile(VirtualFile) returned false)

iterateContentUnderDirectory

public boolean iterateContentUnderDirectory(VirtualFile dir,
                                            ContentIterator processor,
                                            VirtualFileFilter customFilter)

Description copied from interface: FileIndex

Same as FileIndex.iterateContentUnderDirectory(VirtualFile, ContentIterator) but allows to pass additional customFilter to the iterator, in case you need to skip some file system branches using your own logic. If customFilter returns false on a directory, it won't be processed, but iteration will go on.

null filter means that all directories should be processed.

Specified by:

iterateContentUnderDirectory in interface FileIndex

iterateContentUnderDirectory

public boolean iterateContentUnderDirectory(VirtualFile dir,
                                            ContentIterator processor)

Description copied from interface: FileIndex

Processes all files and directories in the content under directory dir (including the directory itself) skipping excluded and ignored files and directories. Does nothing if dir is not in the content.

Specified by:

iterateContentUnderDirectory in interface FileIndex

Returns:

false if files processing was stopped (ContentIterator.processFile(VirtualFile) returned false)

getInfoForFileOrDirectory

public DirectoryInfo getInfoForFileOrDirectory(VirtualFile file)

isContentSourceFile

public boolean isContentSourceFile(VirtualFile file)

Specified by:

isContentSourceFile in interface FileIndex