Package com.intellij.openapi.roots.impl

Class DirectoryInfo

java.lang.Object

com.intellij.openapi.roots.impl.DirectoryInfo

public abstract class DirectoryInfo
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
DirectoryInfo()

Method Summary

Modifier and Type	Method and Description
abstract VirtualFile	getContentRoot()
abstract VirtualFile	getLibraryClassRoot()
abstract Module	getModule()
abstract VirtualFile	getSourceRoot()
abstract SourceFolder	getSourceRootFolder()
abstract java.lang.String	getUnloadedModuleName() Return name of an unloaded module to which content this file or directory belongs or null if it doesn't belong to an unloaded module.
boolean	hasLibraryClassRoot()
abstract boolean	isExcluded(VirtualFile file) Returns true if file located under this directory is excluded from the project.
abstract boolean	isIgnored()
abstract boolean	isInLibrarySource(VirtualFile file)
abstract boolean	isInModuleSource(VirtualFile file) Returns true if file is located under a module source root and not excluded or ignored
abstract boolean	isInProject(VirtualFile file)
abstract boolean	processContentBeneathExcluded(VirtualFile dir, Processor<? super VirtualFile> processor) if dir is excluded and there are content entries under the dir, process them all (as long as processor returns true) and

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectoryInfo

public DirectoryInfo()

Method Detail

isInProject

public abstract boolean isInProject(VirtualFile file)

Parameters:

file - a file under the directory described by this instance.

Returns:

true if file is located under project content or library roots and not excluded or ignored

isIgnored

public abstract boolean isIgnored()

Returns:

true if located under ignored directory

isExcluded

public abstract boolean isExcluded(VirtualFile file)

Returns true if file located under this directory is excluded from the project. If file is a directory it means that all of its content is recursively excluded from the project (except the sub-directories which are explicitly included back, e.g. module roots)

Parameters:

file - a file under the directory described by this instance.

isInModuleSource

public abstract boolean isInModuleSource(VirtualFile file)

Returns true if file is located under a module source root and not excluded or ignored

isInLibrarySource

public abstract boolean isInLibrarySource(VirtualFile file)

Parameters:

file - a file under the directory described by this instance.

Returns:

true if file located under this directory is located in library sources. If file is a directory it means that all of its content is recursively in not part of the libraries.

getSourceRoot

public abstract VirtualFile getSourceRoot()

getSourceRootFolder

public abstract SourceFolder getSourceRootFolder()

hasLibraryClassRoot

public boolean hasLibraryClassRoot()

getLibraryClassRoot

public abstract VirtualFile getLibraryClassRoot()

getContentRoot

public abstract VirtualFile getContentRoot()

getModule

public abstract Module getModule()

getUnloadedModuleName

public abstract java.lang.String getUnloadedModuleName()

Return name of an unloaded module to which content this file or directory belongs or null if it doesn't belong to an unloaded module.

See Also:

UnloadedModuleDescription

processContentBeneathExcluded

public abstract boolean processContentBeneathExcluded(VirtualFile dir,
                                                      Processor<? super VirtualFile> processor)

if dir is excluded and there are content entries under the dir, process them all (as long as processor returns true) and

Returns:

true if all called processors returned true, and false otherwise