Package com.intellij.ide.extensionResources

Class ExtensionsRootType

java.lang.Object

com.intellij.ide.scratch.RootType

com.intellij.ide.extensionResources.ExtensionsRootType

public final class ExtensionsRootType
extends RootType

Extensions root type provide a common interface for plugins to access resources that are modifiable by the user.

Plugin's resources are stored in a directory named %plugin-id% under extensions root.

Plugins can bundle default resources. Bundled resources are searched via ClassLoader.getResources(String) call to plugin's class loader passing EXTENSIONS_PATH concatenated with relative resource path as an argument.

Bundled resources are updated automatically upon plugin version change. For bundled plugins, application version is used.

Field Summary

Fields inherited from class com.intellij.ide.scratch.RootType

ROOT_EP

Method Summary

Modifier and Type	Method and Description
void	extractBundledResources(PluginId pluginId, java.lang.String path)
java.io.File	findResource(PluginId pluginId, java.lang.String path)
java.io.File	findResourceDirectory(PluginId pluginId, java.lang.String path, boolean createIfMissing)
static ExtensionsRootType	getInstance()
PluginId	getOwner(VirtualFile resource)
boolean	isResourceFile(java.io.File file)
static Condition<java.io.File>	regularFileFilter()
java.lang.String	substituteName(Project project, VirtualFile file)

Methods inherited from class com.intellij.ide.scratch.RootType

containsFile, fileClosed, fileOpened, findByClass, findById, findFile, forFile, getAllRootTypes, getDisplayName, getId, isHidden, isIgnored, registerTreeUpdater, substituteIcon, substituteLanguage

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static ExtensionsRootType getInstance()

regularFileFilter

public static Condition<java.io.File> regularFileFilter()

getOwner

public PluginId getOwner(VirtualFile resource)

findResource

public java.io.File findResource(PluginId pluginId,
                                 java.lang.String path)
                          throws java.io.IOException

Throws:

java.io.IOException

findResourceDirectory

public java.io.File findResourceDirectory(PluginId pluginId,
                                          java.lang.String path,
                                          boolean createIfMissing)
                                   throws java.io.IOException

Throws:

java.io.IOException

extractBundledResources

public void extractBundledResources(PluginId pluginId,
                                    java.lang.String path)
                             throws java.io.IOException

Throws:

java.io.IOException

substituteName

public java.lang.String substituteName(Project project,
                                       VirtualFile file)

Overrides:

substituteName in class RootType

isResourceFile

public boolean isResourceFile(java.io.File file)