Package com.intellij.ide.plugins

Class IdeaPluginDescriptorImpl

java.lang.Object

com.intellij.ide.plugins.IdeaPluginDescriptorImpl

All Implemented Interfaces:

IdeaPluginDescriptor, PluginDescriptor

public final class IdeaPluginDescriptorImpl
extends java.lang.Object
implements IdeaPluginDescriptor, PluginDescriptor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IdeaPluginDescriptorImpl.OS

Field Summary

Fields

Modifier and Type	Field and Description
static IdeaPluginDescriptorImpl[]	EMPTY_ARRAY
static java.util.regex.Pattern	EXPLICIT_BIG_NUMBER_PATTERN

Constructor Summary

Constructors

Constructor and Description
IdeaPluginDescriptorImpl(java.nio.file.Path pluginPath, boolean bundled)

Method Summary

Modifier and Type	Method and Description
boolean	allowBundledUpdate()
static java.lang.String	convertExplicitBigNumberInUntilBuildToStar(java.lang.String build) Convert build number like '146.9999' to '146.*' (like plugin repository does) to ensure that plugins which have such values in 'until-build' attribute will be compatible with 146.SNAPSHOT build.
boolean	equals(java.lang.Object o)
java.lang.String	findOptionalDependencyConfigFile(PluginId pluginId)
java.util.List<Element>	getActionDescriptionElements()
ContainerDescriptor	getApp()
ContainerDescriptor	getAppContainerDescriptor()
java.nio.file.Path	getBasePath()
java.lang.String	getCategory()
java.lang.String	getChangeNotes()
java.util.List<java.io.File>	getClassPath() Deprecated. Do not use. If you want to get class loader for own plugin, just use your current class's class loader.
PluginId []	getDependentPluginIds()
java.lang.String	getDescription()
java.util.Map<java.lang.String,java.util.List<Element>>	getExtensions()
ContainerDescriptor	getModule()
ContainerDescriptor	getModuleContainerDescriptor()
java.util.List<PluginId>	getModules()
java.lang.String	getName()
PluginId []	getOptionalDependentPluginIds()
java.io.File	getPath()
java.lang.ClassLoader	getPluginClassLoader()
Disposable	getPluginDisposable()
PluginId	getPluginId()
java.nio.file.Path	getPluginPath()
java.lang.String	getProductCode()
ContainerDescriptor	getProject()
ContainerDescriptor	getProjectContainerDescriptor()
java.util.Date	getReleaseDate()
int	getReleaseVersion()
java.lang.String	getResourceBundleBaseName()
java.lang.String	getSinceBuild()
java.lang.String	getUntilBuild()
java.lang.String	getUrl()
boolean	getUseIdeaClassLoader()
java.lang.String	getVendor()
java.lang.String	getVendorEmail()
java.lang.String	getVendorUrl()
java.lang.String	getVersion()
int	hashCode()
boolean	isBundled()
boolean	isDeleted()
boolean	isEnabled()
boolean	isImplementationDetail() If true, this plugin is hidden from the list of installed plugins in Settings | Plugins.
boolean	isLicenseOptional()
void	loadFromFile(java.io.File file, SafeJdomFactory factory, boolean ignoreMissingInclude) Deprecated. Use PluginManager.loadDescriptorFromFile(IdeaPluginDescriptorImpl, Path, SafeJdomFactory, boolean, Set)
boolean	readExternal(Element element, java.nio.file.Path basePath, com.intellij.ide.plugins.PathBasedJdomXIncluder.PathResolver<?> pathResolver, com.intellij.ide.plugins.DescriptorLoadingContext context, IdeaPluginDescriptorImpl rootDescriptor)
void	registerExtensionPoints(ExtensionsAreaImpl area, ComponentManager componentManager)
void	registerExtensions(ExtensionsAreaImpl area, ComponentManager componentManager, boolean notifyListeners)
void	registerExtensions(ExtensionsAreaImpl area, ComponentManager componentManager, IdeaPluginDescriptorImpl rootDescriptor, java.util.List<java.lang.Runnable> listenerCallbacks)
void	setCategory(java.lang.String category)
void	setDeleted(boolean deleted)
void	setEnabled(boolean enabled)
void	setLoader(java.lang.ClassLoader loader)
void	setUrl(java.lang.String val)
java.lang.String	toString()
boolean	unloadClassLoader()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.intellij.openapi.extensions.PluginDescriptor

getDownloads

Field Detail

EMPTY_ARRAY

public static final IdeaPluginDescriptorImpl[] EMPTY_ARRAY

EXPLICIT_BIG_NUMBER_PATTERN

public static final java.util.regex.Pattern EXPLICIT_BIG_NUMBER_PATTERN

Constructor Detail

IdeaPluginDescriptorImpl

public IdeaPluginDescriptorImpl(java.nio.file.Path pluginPath,
                                boolean bundled)

Method Detail

getApp

public ContainerDescriptor getApp()

getProject

public ContainerDescriptor getProject()

getModule

public ContainerDescriptor getModule()

getPath

public java.io.File getPath()

Specified by:

getPath in interface PluginDescriptor

getPluginPath

public java.nio.file.Path getPluginPath()

Specified by:

getPluginPath in interface PluginDescriptor

getBasePath

public java.nio.file.Path getBasePath()

loadFromFile

@Deprecated
public void loadFromFile(java.io.File file,
                         SafeJdomFactory factory,
                         boolean ignoreMissingInclude)
                  throws java.io.IOException,
                         JDOMException

Deprecated. Use PluginManager.loadDescriptorFromFile(IdeaPluginDescriptorImpl, Path, SafeJdomFactory, boolean, Set)

Throws:

java.io.IOException

JDOMException

readExternal

public boolean readExternal(Element element,
                            java.nio.file.Path basePath,
                            com.intellij.ide.plugins.PathBasedJdomXIncluder.PathResolver<?> pathResolver,
                            com.intellij.ide.plugins.DescriptorLoadingContext context,
                            IdeaPluginDescriptorImpl rootDescriptor)

convertExplicitBigNumberInUntilBuildToStar

public static java.lang.String convertExplicitBigNumberInUntilBuildToStar(java.lang.String build)

Convert build number like '146.9999' to '146.*' (like plugin repository does) to ensure that plugins which have such values in 'until-build' attribute will be compatible with 146.SNAPSHOT build.

registerExtensionPoints

public void registerExtensionPoints(ExtensionsAreaImpl area,
                                    ComponentManager componentManager)

getAppContainerDescriptor

public ContainerDescriptor getAppContainerDescriptor()

getProjectContainerDescriptor

public ContainerDescriptor getProjectContainerDescriptor()

getModuleContainerDescriptor

public ContainerDescriptor getModuleContainerDescriptor()

registerExtensions

public void registerExtensions(ExtensionsAreaImpl area,
                               ComponentManager componentManager,
                               boolean notifyListeners)

registerExtensions

public void registerExtensions(ExtensionsAreaImpl area,
                               ComponentManager componentManager,
                               IdeaPluginDescriptorImpl rootDescriptor,
                               java.util.List<java.lang.Runnable> listenerCallbacks)

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface PluginDescriptor

getChangeNotes

public java.lang.String getChangeNotes()

Specified by:

getChangeNotes in interface PluginDescriptor

getName

public java.lang.String getName()

Specified by:

getName in interface PluginDescriptor

getProductCode

public java.lang.String getProductCode()

Specified by:

getProductCode in interface PluginDescriptor

getReleaseDate

public java.util.Date getReleaseDate()

Specified by:

getReleaseDate in interface PluginDescriptor

getReleaseVersion

public int getReleaseVersion()

Specified by:

getReleaseVersion in interface PluginDescriptor

isLicenseOptional

public boolean isLicenseOptional()

Specified by:

isLicenseOptional in interface PluginDescriptor

getDependentPluginIds

public PluginId [] getDependentPluginIds()

Specified by:

getDependentPluginIds in interface PluginDescriptor

getOptionalDependentPluginIds

public PluginId [] getOptionalDependentPluginIds()

Specified by:

getOptionalDependentPluginIds in interface PluginDescriptor

getVendor

public java.lang.String getVendor()

Specified by:

getVendor in interface PluginDescriptor

getVersion

public java.lang.String getVersion()

Specified by:

getVersion in interface PluginDescriptor

getResourceBundleBaseName

public java.lang.String getResourceBundleBaseName()

Specified by:

getResourceBundleBaseName in interface PluginDescriptor

getCategory

public java.lang.String getCategory()

Specified by:

getCategory in interface PluginDescriptor

setCategory

public void setCategory(java.lang.String category)

getExtensions

public java.util.Map<java.lang.String,java.util.List<Element>> getExtensions()

getClassPath

@Deprecated
public java.util.List<java.io.File> getClassPath()

Deprecated. Do not use. If you want to get class loader for own plugin, just use your current class's class loader.

getActionDescriptionElements

public java.util.List<Element> getActionDescriptionElements()

Specified by:

getActionDescriptionElements in interface PluginDescriptor

getVendorEmail

public java.lang.String getVendorEmail()

Specified by:

getVendorEmail in interface PluginDescriptor

getVendorUrl

public java.lang.String getVendorUrl()

Specified by:

getVendorUrl in interface PluginDescriptor

getUrl

public java.lang.String getUrl()

Specified by:

getUrl in interface PluginDescriptor

setUrl

public void setUrl(java.lang.String val)

isDeleted

public boolean isDeleted()

setDeleted

public void setDeleted(boolean deleted)

setLoader

public void setLoader(java.lang.ClassLoader loader)

unloadClassLoader

public boolean unloadClassLoader()

getPluginId

public PluginId getPluginId()

Specified by:

getPluginId in interface PluginDescriptor

Returns:

plugin id or null if the descriptor is the nested (optional dependency) descriptor

getPluginClassLoader

public java.lang.ClassLoader getPluginClassLoader()

Specified by:

getPluginClassLoader in interface PluginDescriptor

getUseIdeaClassLoader

public boolean getUseIdeaClassLoader()

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface PluginDescriptor

setEnabled

public void setEnabled(boolean enabled)

Specified by:

setEnabled in interface PluginDescriptor

getPluginDisposable

public Disposable getPluginDisposable()

Specified by:

getPluginDisposable in interface PluginDescriptor

getSinceBuild

public java.lang.String getSinceBuild()

Specified by:

getSinceBuild in interface PluginDescriptor

getUntilBuild

public java.lang.String getUntilBuild()

Specified by:

getUntilBuild in interface PluginDescriptor

isBundled

public boolean isBundled()

Specified by:

isBundled in interface PluginDescriptor

allowBundledUpdate

public boolean allowBundledUpdate()

Specified by:

allowBundledUpdate in interface PluginDescriptor

isImplementationDetail

public boolean isImplementationDetail()

Description copied from interface: PluginDescriptor

If true, this plugin is hidden from the list of installed plugins in Settings | Plugins.

Specified by:

isImplementationDetail in interface PluginDescriptor

getModules

public java.util.List<PluginId> getModules()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

findOptionalDependencyConfigFile

public java.lang.String findOptionalDependencyConfigFile(PluginId pluginId)