Package com.intellij.openapi.roots.impl

Class ContentEntryImpl

java.lang.Object

com.intellij.openapi.roots.impl.ContentEntryImpl

All Implemented Interfaces:

Disposable, ContentEntry, Synthetic, java.lang.Comparable<ContentEntryImpl>

public class ContentEntryImpl
extends java.lang.Object
implements ContentEntry, java.lang.Comparable<ContentEntryImpl>

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable

Disposable.Parent

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ELEMENT_NAME
static java.lang.String	URL_ATTRIBUTE

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()
ContentEntry	cloneEntry(RootModelImpl rootModel)
int	compareTo(ContentEntryImpl other)
void	dispose() Usually not invoked directly, see class javadoc.
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.
RootModelImpl	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.
boolean	isDisposed()
boolean	isSynthetic()
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)
void	writeExternal(Element element)

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.ContentEntry

getRootModel

Field Detail

ELEMENT_NAME

public static final java.lang.String ELEMENT_NAME

See Also:

Constant Field Values

URL_ATTRIBUTE

public static final java.lang.String URL_ATTRIBUTE

See Also:

Constant Field Values

Method Detail

getFile

public VirtualFile getFile()

Description copied from interface: ContentEntry

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

Specified by:

getFile in interface ContentEntry

Returns:

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

getUrl

public java.lang.String getUrl()

Description copied from interface: ContentEntry

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

Specified by:

getUrl in interface ContentEntry

Returns:

URL of content root, that should never be null.

getSourceFolders

public SourceFolder [] getSourceFolders()

Description copied from interface: ContentEntry

Returns the list of source roots under this content root.

Specified by:

getSourceFolders in interface ContentEntry

Returns:

list of this ContentEntry SourceFolders

getSourceFolders

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

Specified by:

getSourceFolders in interface ContentEntry

Parameters:

rootType - type of accepted source roots

Returns:

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

getSourceFolders

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

Specified by:

getSourceFolders in interface ContentEntry

Parameters:

rootTypes - types of accepted source roots

Returns:

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

getSourceFolderFiles

public VirtualFile [] getSourceFolderFiles()

Description copied from interface: ContentEntry

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

Specified by:

getSourceFolderFiles in interface ContentEntry

Returns:

list of all valid source roots.

getExcludeFolders

public ExcludeFolder [] getExcludeFolders()

Description copied from interface: ContentEntry

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

Specified by:

getExcludeFolders in interface ContentEntry

Returns:

list of this ContentEntry ExcludeFolders

getExcludeFolderUrls

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

Specified by:

getExcludeFolderUrls in interface ContentEntry

Returns:

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

getExcludeFolderFiles

public VirtualFile [] getExcludeFolderFiles()

Description copied from interface: ContentEntry

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

Specified by:

getExcludeFolderFiles in interface ContentEntry

Returns:

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

addSourceFolder

public SourceFolder addSourceFolder(VirtualFile file,
                                    boolean isTestSource)

Description copied from interface: ContentEntry

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

Specified by:

addSourceFolder in interface ContentEntry

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

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

Description copied from interface: ContentEntry

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

Specified by:

addSourceFolder in interface ContentEntry

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

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

Specified by:

addSourceFolder in interface ContentEntry

addSourceFolder

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

Specified by:

addSourceFolder in interface ContentEntry

addSourceFolder

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

Description copied from interface: ContentEntry

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

Specified by:

addSourceFolder in interface ContentEntry

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

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

Specified by:

addSourceFolder in interface ContentEntry

addSourceFolder

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

Specified by:

addSourceFolder in interface ContentEntry

removeSourceFolder

public void removeSourceFolder(SourceFolder sourceFolder)

Description copied from interface: ContentEntry

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

Specified by:

removeSourceFolder in interface ContentEntry

Parameters:

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

clearSourceFolders

public void clearSourceFolders()

Specified by:

clearSourceFolders in interface ContentEntry

addExcludeFolder

public ExcludeFolder addExcludeFolder(VirtualFile file)

Description copied from interface: ContentEntry

Adds an exclude root under the content root.

Specified by:

addExcludeFolder in interface ContentEntry

Parameters:

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

Returns:

the object representing the added root.

addExcludeFolder

public ExcludeFolder addExcludeFolder(java.lang.String url)

Description copied from interface: ContentEntry

Adds an exclude root under the content root.

Specified by:

addExcludeFolder in interface ContentEntry

Parameters:

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

Returns:

the object representing the added root.

removeExcludeFolder

public void removeExcludeFolder(ExcludeFolder excludeFolder)

Description copied from interface: ContentEntry

Removes an exclude root from this content root.

Specified by:

removeExcludeFolder in interface ContentEntry

Parameters:

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

removeExcludeFolder

public boolean removeExcludeFolder(java.lang.String url)

Description copied from interface: ContentEntry

Removes an exclude root from this content root.

Specified by:

removeExcludeFolder in interface ContentEntry

Parameters:

url - url of the exclude root

Returns:

true if the exclude root was removed

clearExcludeFolders

public void clearExcludeFolders()

Specified by:

clearExcludeFolders in interface ContentEntry

getExcludePatterns

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

Description copied from interface: ContentEntry

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.

Specified by:

getExcludePatterns in interface ContentEntry

addExcludePattern

public void addExcludePattern(java.lang.String pattern)

Specified by:

addExcludePattern in interface ContentEntry

removeExcludePattern

public void removeExcludePattern(java.lang.String pattern)

Specified by:

removeExcludePattern in interface ContentEntry

setExcludePatterns

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

Specified by:

setExcludePatterns in interface ContentEntry

isSynthetic

public boolean isSynthetic()

Specified by:

isSynthetic in interface Synthetic

cloneEntry

public ContentEntry cloneEntry(RootModelImpl rootModel)

writeExternal

public void writeExternal(Element element)
                   throws WriteExternalException

Throws:

WriteExternalException

compareTo

public int compareTo(ContentEntryImpl other)

Specified by:

compareTo in interface java.lang.Comparable<ContentEntryImpl>

getRootModel

public RootModelImpl getRootModel()

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

isDisposed

public boolean isDisposed()