Package com.intellij.openapi.roots

Interface ContentEntry

All Superinterfaces:

Synthetic

All Known Implementing Classes:

ContentEntryImpl, JpsContentEntry

public interface ContentEntry
extends Synthetic

Represents a module's content root. You can get existing entries with ModuleRootModel.getContentEntries() or create a new one with ModifiableRootModel.addContentEntry(VirtualFile).

See Also:

ModuleRootModel.getContentEntries(), ModifiableRootModel.addContentEntry(VirtualFile)

Method Summary

Modifier and Type	Method and Description
ExcludeFolder	addExcludeFolder(java.lang.String url) Adds an exclude root under the content root.
ExcludeFolder	addExcludeFolder(VirtualFile file) Adds an exclude root under the content root.
void	addExcludePattern(java.lang.String pattern)
SourceFolder	addSourceFolder(java.lang.String url, boolean isTestSource) Adds a source or test source root under the content root.
<P extends JpsElement> SourceFolder	addSourceFolder(java.lang.String url, JpsModuleSourceRootType<P> type)
<P extends JpsElement> SourceFolder	addSourceFolder(java.lang.String url, JpsModuleSourceRootType<P> type, P properties)
SourceFolder	addSourceFolder(VirtualFile file, boolean isTestSource) Adds a source or test source root under the content root.
SourceFolder	addSourceFolder(VirtualFile file, boolean isTestSource, java.lang.String packagePrefix) Adds a source or test source root with the specified package prefix under the content root.
<P extends JpsElement> SourceFolder	addSourceFolder(VirtualFile file, JpsModuleSourceRootType<P> type)
<P extends JpsElement> SourceFolder	addSourceFolder(VirtualFile file, JpsModuleSourceRootType<P> type, P properties)
void	clearExcludeFolders()
void	clearSourceFolders()
VirtualFile []	getExcludeFolderFiles() Returns the list of files and directories for valid excluded roots under this content root.
ExcludeFolder []	getExcludeFolders() Returns the list of excluded roots configured under this content root.
java.util.List<java.lang.String>	getExcludeFolderUrls()
java.util.List<java.lang.String>	getExcludePatterns() Returns patterns for names of files which should be excluded from this content root.
VirtualFile	getFile() Returns the root file or directory for the content root, if it is valid.
ModuleRootModel	getRootModel()
VirtualFile []	getSourceFolderFiles() Returns the list of files and directories for valid source roots under this content root.
SourceFolder []	getSourceFolders() Returns the list of source roots under this content root.
java.util.List<SourceFolder>	getSourceFolders(JpsModuleSourceRootType<?> rootType)
java.util.List<SourceFolder>	getSourceFolders(java.util.Set<? extends JpsModuleSourceRootType<?>> rootTypes)
java.lang.String	getUrl() Returns the URL of content root.
void	removeExcludeFolder(ExcludeFolder excludeFolder) Removes an exclude root from this content root.
boolean	removeExcludeFolder(java.lang.String url) Removes an exclude root from this content root.
void	removeExcludePattern(java.lang.String pattern)
void	removeSourceFolder(SourceFolder sourceFolder) Removes a source or test source root from this content root.
void	setExcludePatterns(java.util.List<java.lang.String> patterns)

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

isSynthetic

Method Detail

getFile

VirtualFile getFile()

Returns the root file or directory for the content root, if it is valid.

Returns:

the content root file or directory, or null if content entry is invalid.

getUrl

java.lang.String getUrl()

Returns the URL of content root. To validate returned roots, use VirtualFileManager.findFileByUrl(String)

Returns:

URL of content root, that should never be null.

getSourceFolders

SourceFolder [] getSourceFolders()

Returns the list of source roots under this content root.

Returns:

list of this ContentEntry SourceFolders

getSourceFolders

java.util.List<SourceFolder> getSourceFolders(JpsModuleSourceRootType<?> rootType)

Parameters:

rootType - type of accepted source roots

Returns:

list of source roots of the specified type containing in this content root

getSourceFolders

java.util.List<SourceFolder> getSourceFolders(java.util.Set<? extends JpsModuleSourceRootType<?>> rootTypes)

Parameters:

rootTypes - types of accepted source roots

Returns:

list of source roots of the specified types containing in this content root

getSourceFolderFiles

VirtualFile [] getSourceFolderFiles()

Returns the list of files and directories for valid source roots under this content root.

Returns:

list of all valid source roots.

getExcludeFolders

ExcludeFolder [] getExcludeFolders()

Returns the list of excluded roots configured under this content root. The result doesn't include synthetic excludes like the module output.

Returns:

list of this ContentEntry ExcludeFolders

getExcludeFolderUrls

java.util.List<java.lang.String> getExcludeFolderUrls()

Returns:

list of URLs for all excluded roots under this content root including synthetic excludes like the module output

getExcludeFolderFiles

VirtualFile [] getExcludeFolderFiles()

Returns the list of files and directories for valid excluded roots under this content root.

Returns:

list of all valid exclude roots including synthetic excludes like the module output

addSourceFolder

SourceFolder addSourceFolder(VirtualFile file,
                             boolean isTestSource)

Adds a source or test source root under the content root.

Parameters:

file - the file or directory to add as a source root.

isTestSource - true if the file or directory is added as a test source root.

Returns:

the object representing the added root.

addSourceFolder

SourceFolder addSourceFolder(VirtualFile file,
                             boolean isTestSource,
                             java.lang.String packagePrefix)

Adds a source or test source root with the specified package prefix under the content root.

Parameters:

file - the file or directory to add as a source root.

isTestSource - true if the file or directory is added as a test source root.

packagePrefix - the package prefix for the root to add, or an empty string if no package prefix is required.

Returns:

the object representing the added root.

addSourceFolder

<P extends JpsElement> SourceFolder addSourceFolder(VirtualFile file,
                                                    JpsModuleSourceRootType<P> type,
                                                    P properties)

addSourceFolder

<P extends JpsElement> SourceFolder addSourceFolder(VirtualFile file,
                                                    JpsModuleSourceRootType<P> type)

addSourceFolder

SourceFolder addSourceFolder(java.lang.String url,
                             boolean isTestSource)

Adds a source or test source root under the content root.

Parameters:

url - the file or directory url to add as a source root.

isTestSource - true if the file or directory is added as a test source root.

Returns:

the object representing the added root.

addSourceFolder

<P extends JpsElement> SourceFolder addSourceFolder(java.lang.String url,
                                                    JpsModuleSourceRootType<P> type)

addSourceFolder

<P extends JpsElement> SourceFolder addSourceFolder(java.lang.String url,
                                                    JpsModuleSourceRootType<P> type,
                                                    P properties)

removeSourceFolder

void removeSourceFolder(SourceFolder sourceFolder)

Removes a source or test source root from this content root.

Parameters:

sourceFolder - the source root to remove (must belong to this content root).

clearSourceFolders

void clearSourceFolders()

addExcludeFolder

ExcludeFolder addExcludeFolder(VirtualFile file)

Adds an exclude root under the content root.

Parameters:

file - the file or directory to add as an exclude root.

Returns:

the object representing the added root.

addExcludeFolder

ExcludeFolder addExcludeFolder(java.lang.String url)

Adds an exclude root under the content root.

Parameters:

url - the file or directory url to add as an exclude root.

Returns:

the object representing the added root.

removeExcludeFolder

void removeExcludeFolder(ExcludeFolder excludeFolder)

Removes an exclude root from this content root.

Parameters:

excludeFolder - the exclude root to remove (must belong to this content root).

removeExcludeFolder

boolean removeExcludeFolder(java.lang.String url)

Removes an exclude root from this content root.

Parameters:

url - url of the exclude root

Returns:

true if the exclude root was removed

clearExcludeFolders

void clearExcludeFolders()

getExcludePatterns

java.util.List<java.lang.String> getExcludePatterns()

Returns patterns for names of files which should be excluded from this content root. If name of a file under this content root matches any of the patterns it'll be excluded from the module, if name of a directory matches any of the patterns the directory and all of its contents will be excluded. '?' and '*' wildcards are supported.

addExcludePattern

void addExcludePattern(java.lang.String pattern)

removeExcludePattern

void removeExcludePattern(java.lang.String pattern)

setExcludePatterns

void setExcludePatterns(java.util.List<java.lang.String> patterns)

getRootModel

ModuleRootModel getRootModel()