icy.plugin

Class PluginDescriptor

java.lang.Object

icy.plugin.PluginDescriptor

All Implemented Interfaces:

XMLPersistent

public class PluginDescriptor
extends java.lang.Object
implements XMLPersistent

The plugin descriptor contains all the data needed to launch a plugin.

Author:

Fabrice de Chaumont & Stephane

See Also:

PluginLauncher

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PluginDescriptor.PluginClassNameSorter Sort plugins on class name.
static class	PluginDescriptor.PluginIdent
static class	PluginDescriptor.PluginKernelNameSorter Sort plugins on name with kernel plugins appearing first.
static class	PluginDescriptor.PluginNameSorter Sort plugins on name.
static class	PluginDescriptor.PluginOnlineIdent

Field Summary

Fields

Modifier and Type	Field and Description
static javax.swing.ImageIcon	DEFAULT_ICON
static java.awt.Image	DEFAULT_IMAGE
static int	ICON_SIZE
static java.lang.String	ID_AUTHOR
static java.lang.String	ID_CHANGELOG
static java.lang.String	ID_CLASSNAME Deprecated. Use PluginDescriptor.PluginIdent.ID_CLASSNAME instead
static java.lang.String	ID_DEPENDENCIES
static java.lang.String	ID_DEPENDENCY
static java.lang.String	ID_DESCRIPTION
static java.lang.String	ID_EMAIL
static java.lang.String	ID_ICON_URL
static java.lang.String	ID_IMAGE_URL
static java.lang.String	ID_JAR_URL
static java.lang.String	ID_NAME
static java.lang.String	ID_REQUIRED_KERNEL_VERSION Deprecated. Use PluginDescriptor.PluginIdent.ID_REQUIRED_KERNEL_VERSION instead
static java.lang.String	ID_URL
static java.lang.String	ID_WEB
static int	IMAGE_SIZE

Constructor Summary

Constructors

Constructor and Description
PluginDescriptor()
PluginDescriptor(java.lang.Class<? extends Plugin> clazz) Create from class, used for local plugin.
PluginDescriptor(PluginDescriptor.PluginOnlineIdent ident, RepositoryPreferences.RepositoryInfo repos) Create from plugin online identifier, used for online plugin only.

Method Summary

Methods

Modifier and Type	Method and Description
static void	addToList(java.util.List<PluginDescriptor> list, PluginDescriptor plugin)
static void	addToList(java.util.List<PluginDescriptor> list, PluginDescriptor plugin, int position)
boolean	equals(java.lang.Object obj)
static boolean	existInList(java.util.List<PluginDescriptor> list, PluginDescriptor.PluginIdent ident) Returns true if the specified plugin is present in the specified list.
static boolean	existInList(java.util.List<PluginDescriptor> list, PluginDescriptor plugin) Returns true if the specified plugin is present in the specified list.
static boolean	existInList(java.util.List<PluginDescriptor> list, java.lang.String className) Returns true if the specified plugin is present in the specified list.
static boolean	existInList(java.util.Set<PluginDescriptor> plugins, PluginDescriptor.PluginIdent ident)
java.lang.String	getAuthor() Returns the author's plugin name.
java.lang.String	getAuthorPackageName() Returns the author package name (first part of simple package name)
java.lang.String	getChangeLog()
java.lang.String	getChangesLog() Deprecated. Use getChangeLog() instead
java.lang.String	getClassAsString() Deprecated. useless method
java.lang.String	getClassName() Returns the plugin class name.
java.lang.String	getDesc() Deprecated. use getDescription() instead
java.lang.String	getDescription()
java.lang.String	getEmail()
java.lang.String	getFilename() return associated filename
javax.swing.ImageIcon	getIcon()
java.awt.Image	getIconAsImage()
java.lang.String	getIconExtension() return icon extension
java.lang.String	getIconFilename() return icon filename
java.lang.String	getIconUrl()
PluginDescriptor.PluginIdent	getIdent()
java.awt.Image	getImage()
java.lang.String	getImageExtension() return image extension
java.lang.String	getImageFilename() return image filename
java.lang.String	getImageUrl()
static int	getIndex(java.util.List<PluginDescriptor> list, PluginDescriptor.PluginIdent ident) Returns the index for the specified plugin in the specified list.
static int	getIndex(java.util.List<PluginDescriptor> list, PluginDescriptor plugin) Returns the index for the specified plugin in the specified list.
static int	getIndex(java.util.List<PluginDescriptor> list, java.lang.String className) Returns the index for the specified plugin in the specified list.
java.lang.String	getJarExtension() Returns the JAR file extension.
java.lang.String	getJarFilename() return jar filename
java.lang.String	getJarUrl()
java.lang.String	getName()
java.lang.String	getPackageName() Returns the package name of the plugin class.
static PluginDescriptor	getPlugin(java.util.List<PluginDescriptor> list, PluginDescriptor.PluginIdent ident, boolean acceptNewer)
static PluginDescriptor	getPlugin(java.util.List<PluginDescriptor> list, java.lang.String className)
java.lang.Class<? extends Plugin>	getPluginClass()
java.lang.String	getPluginJarPath()
static java.util.ArrayList<PluginDescriptor>	getPlugins(java.util.List<PluginDescriptor> list, java.lang.String className)
RepositoryPreferences.RepositoryInfo	getRepository()
java.util.List<PluginDescriptor.PluginIdent>	getRequired()
Version	getRequiredKernelVersion()
java.lang.String	getSimpleClassName()
java.lang.String	getSimplePackageName() Returns the minimum package name (remove "icy" or/and "plugin" header)
java.lang.String	getUrl()
Version	getVersion()
java.lang.String	getWeb() Returns the website url of this plugin.
java.lang.String	getXMLExtension() Returns the XML file extension.
java.lang.String	getXMLFilename() return xml filename (local XML file)
java.lang.String	getXmlUrl()
int	hashCode()
boolean	isAbstract() Return true if the plugin class is abstract
boolean	isActionable() return true if the plugin has an action which can be started from menu
boolean	isAllLoaded() Returns true if both descriptor and images are loaded.
boolean	isBeta() Return true if the plugin is in beta state
boolean	isBundled() Return true if the plugin is bundled inside another plugin (mean it does not have a proper descriptor)
boolean	isChangeLogLoaded() Returns true if change log is loaded.
boolean	isClassLoaded()
boolean	isDescriptorLoaded() Returns true if descriptor is loaded.
boolean	isEnabled()
boolean	isIconLoaded() Returns true if icon is loaded.
boolean	isImageLoaded() Returns true if image is loaded.
boolean	isImagesLoaded() Returns true if image and icon are loaded.
boolean	isInstalled() Return true if plugin is installed (corresponding JAR file exist)
boolean	isInstanceOf(java.lang.Class<?> baseClazz) Check if the plugin class is an instance of (or subclass of) the specified class.
boolean	isInterface() Return true if the plugin class is an interface
boolean	isKernelPlugin() Return true if this plugin is a system application plugin (declared in plugins.kernel package).
boolean	isLoaded() Deprecated. Use isDescriptorLoaded() instead
boolean	isNewer(PluginDescriptor plugin)
boolean	isNewerOrEqual(PluginDescriptor plugin)
boolean	isOlder(PluginDescriptor plugin)
boolean	isOlderOrEqual(PluginDescriptor plugin)
boolean	isPrivate() Return true if the plugin class is private
boolean	load(boolean loadImages) Deprecated. Use loadDescriptor() or loadAll() instead
boolean	loadAll() Load descriptor and images if not already done
boolean	loadChangeLog() Load change log field (xmlUrl field should be correctly filled)
boolean	loadDescriptor() Load descriptor informations (xmlUrl field should be correctly filled)
boolean	loadDescriptor(boolean reload) Load descriptor informations (xmlUrl field should be correctly filled).
boolean	loadFromXML(org.w3c.dom.Node node) LOAD
boolean	loadFromXML(org.w3c.dom.Node node, boolean loadChangeLog)
boolean	loadFromXML(java.lang.String path)
boolean	loadFromXML(java.net.URL xmlUrl)
boolean	loadIcon() Load 64x64 icon (icon url field should be correctly filled)
boolean	loadImage() Load 256x256 image (image url field should be correctly filled)
boolean	loadImages() Load icon and image (both icon and image url fields should be correctly filled)
static boolean	removeFromList(java.util.List<PluginDescriptor> list, java.lang.String className)
boolean	requires(PluginDescriptor plugin) Return true if specified plugin is required by current plugin
boolean	saveToXML()
boolean	saveToXML(org.w3c.dom.Node node) SAVE
void	setAuthor(java.lang.String author)
void	setChangeLog(java.lang.String value)
void	setChangesLog(java.lang.String value) Deprecated. use setChangeLog(String)
void	setDescription(java.lang.String desc)
void	setEmail(java.lang.String email)
void	setEnabled(boolean enabled)
void	setIconUrl(java.lang.String iconUrl)
void	setImageUrl(java.lang.String imageUrl)
void	setJarUrl(java.lang.String jarUrl)
void	setName(java.lang.String name)
void	setRepository(RepositoryPreferences.RepositoryInfo repository)
void	setWeb(java.lang.String web)
void	setXmlUrl(java.lang.String xmlUrl)
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

ICON_SIZE

public static final int ICON_SIZE

See Also:

Constant Field Values

IMAGE_SIZE

public static final int IMAGE_SIZE

See Also:

Constant Field Values

DEFAULT_ICON

public static final javax.swing.ImageIcon DEFAULT_ICON

DEFAULT_IMAGE

public static final java.awt.Image DEFAULT_IMAGE

ID_CLASSNAME

@Deprecated
public static final java.lang.String ID_CLASSNAME

Deprecated. Use PluginDescriptor.PluginIdent.ID_CLASSNAME instead

See Also:

Constant Field Values

ID_REQUIRED_KERNEL_VERSION

@Deprecated
public static final java.lang.String ID_REQUIRED_KERNEL_VERSION

Deprecated. Use PluginDescriptor.PluginIdent.ID_REQUIRED_KERNEL_VERSION instead

See Also:

Constant Field Values

ID_URL

public static final java.lang.String ID_URL

See Also:

Constant Field Values

ID_NAME

public static final java.lang.String ID_NAME

See Also:

Constant Field Values

ID_JAR_URL

public static final java.lang.String ID_JAR_URL

See Also:

Constant Field Values

ID_IMAGE_URL

public static final java.lang.String ID_IMAGE_URL

See Also:

Constant Field Values

ID_ICON_URL

public static final java.lang.String ID_ICON_URL

See Also:

Constant Field Values

ID_AUTHOR

public static final java.lang.String ID_AUTHOR

See Also:

Constant Field Values

ID_CHANGELOG

public static final java.lang.String ID_CHANGELOG

See Also:

Constant Field Values

ID_WEB

public static final java.lang.String ID_WEB

See Also:

Constant Field Values

ID_EMAIL

public static final java.lang.String ID_EMAIL

See Also:

Constant Field Values

ID_DESCRIPTION

public static final java.lang.String ID_DESCRIPTION

See Also:

Constant Field Values

ID_DEPENDENCIES

public static final java.lang.String ID_DEPENDENCIES

See Also:

Constant Field Values

ID_DEPENDENCY

public static final java.lang.String ID_DEPENDENCY

See Also:

Constant Field Values

Constructor Detail

PluginDescriptor

public PluginDescriptor()

PluginDescriptor

public PluginDescriptor(java.lang.Class<? extends Plugin> clazz)

Create from class, used for local plugin.

PluginDescriptor

public PluginDescriptor(PluginDescriptor.PluginOnlineIdent ident,
                RepositoryPreferences.RepositoryInfo repos)
                 throws java.lang.IllegalArgumentException

Create from plugin online identifier, used for online plugin only.

Throws:

java.lang.IllegalArgumentException

Method Detail

getIndex

public static int getIndex(java.util.List<PluginDescriptor> list,
           PluginDescriptor plugin)

Returns the index for the specified plugin in the specified list.
Returns -1 if not found.

getIndex

public static int getIndex(java.util.List<PluginDescriptor> list,
           PluginDescriptor.PluginIdent ident)

Returns the index for the specified plugin in the specified list.
Returns -1 if not found.

getIndex

public static int getIndex(java.util.List<PluginDescriptor> list,
           java.lang.String className)

Returns the index for the specified plugin in the specified list.
Returns -1 if not found.

existInList

public static boolean existInList(java.util.List<PluginDescriptor> list,
                  PluginDescriptor plugin)

Returns true if the specified plugin is present in the specified list.

existInList

public static boolean existInList(java.util.List<PluginDescriptor> list,
                  PluginDescriptor.PluginIdent ident)

Returns true if the specified plugin is present in the specified list.

existInList

public static boolean existInList(java.util.List<PluginDescriptor> list,
                  java.lang.String className)

Returns true if the specified plugin is present in the specified list.

existInList

public static boolean existInList(java.util.Set<PluginDescriptor> plugins,
                  PluginDescriptor.PluginIdent ident)

addToList

public static void addToList(java.util.List<PluginDescriptor> list,
             PluginDescriptor plugin,
             int position)

addToList

public static void addToList(java.util.List<PluginDescriptor> list,
             PluginDescriptor plugin)

removeFromList

public static boolean removeFromList(java.util.List<PluginDescriptor> list,
                     java.lang.String className)

getPlugins

public static java.util.ArrayList<PluginDescriptor> getPlugins(java.util.List<PluginDescriptor> list,
                                               java.lang.String className)

getPlugin

public static PluginDescriptor getPlugin(java.util.List<PluginDescriptor> list,
                         java.lang.String className)

getPlugin

public static PluginDescriptor getPlugin(java.util.List<PluginDescriptor> list,
                         PluginDescriptor.PluginIdent ident,
                         boolean acceptNewer)

load

@Deprecated
public boolean load(boolean loadImages)

Deprecated. Use loadDescriptor() or loadAll() instead

loadDescriptor

public boolean loadDescriptor()

Load descriptor informations (xmlUrl field should be correctly filled)

loadDescriptor

public boolean loadDescriptor(boolean reload)

Load descriptor informations (xmlUrl field should be correctly filled).
Returns false if the operation failed.

loadChangeLog

public boolean loadChangeLog()

Load change log field (xmlUrl field should be correctly filled)

loadIcon

public boolean loadIcon()

Load 64x64 icon (icon url field should be correctly filled)

loadImage

public boolean loadImage()

Load 256x256 image (image url field should be correctly filled)

loadImages

public boolean loadImages()

Load icon and image (both icon and image url fields should be correctly filled)

loadAll

public boolean loadAll()

Load descriptor and images if not already done

isInstanceOf

public boolean isInstanceOf(java.lang.Class<?> baseClazz)

Check if the plugin class is an instance of (or subclass of) the specified class.

isAbstract

public boolean isAbstract()

Return true if the plugin class is abstract

isPrivate

public boolean isPrivate()

Return true if the plugin class is private

isInterface

public boolean isInterface()

Return true if the plugin class is an interface

isActionable

public boolean isActionable()

return true if the plugin has an action which can be started from menu

isBundled

public boolean isBundled()

Return true if the plugin is bundled inside another plugin (mean it does not have a proper descriptor)

isBeta

public boolean isBeta()

Return true if the plugin is in beta state

isKernelPlugin

public boolean isKernelPlugin()

Return true if this plugin is a system application plugin (declared in plugins.kernel package).

loadFromXML

public boolean loadFromXML(java.lang.String path)

loadFromXML

public boolean loadFromXML(java.net.URL xmlUrl)

loadFromXML

public boolean loadFromXML(org.w3c.dom.Node node)

Description copied from interface: XMLPersistent

LOAD

Specified by:

loadFromXML in interface XMLPersistent

loadFromXML

public boolean loadFromXML(org.w3c.dom.Node node,
                  boolean loadChangeLog)

saveToXML

public boolean saveToXML()

saveToXML

public boolean saveToXML(org.w3c.dom.Node node)

Description copied from interface: XMLPersistent

SAVE

Specified by:

saveToXML in interface XMLPersistent

isClassLoaded

public boolean isClassLoaded()

getClassName

public java.lang.String getClassName()

Returns the plugin class name.
Ex: "plugins.tutorial.Example1"

getSimpleClassName

public java.lang.String getSimpleClassName()

getPackageName

public java.lang.String getPackageName()

Returns the package name of the plugin class.

getSimplePackageName

public java.lang.String getSimplePackageName()

Returns the minimum package name (remove "icy" or/and "plugin" header)

getAuthorPackageName

public java.lang.String getAuthorPackageName()

Returns the author package name (first part of simple package name)

getClassAsString

@Deprecated
public java.lang.String getClassAsString()

Deprecated. useless method

getPluginClass

public java.lang.Class<? extends Plugin> getPluginClass()

Returns:

the pluginClass

getPluginJarPath

public java.lang.String getPluginJarPath()

Returns:

the JAR file hosting this plugin (returns null if the plugin is not installed).

getFilename

public java.lang.String getFilename()

return associated filename

getXMLExtension

public java.lang.String getXMLExtension()

Returns the XML file extension.

getXMLFilename

public java.lang.String getXMLFilename()

return xml filename (local XML file)

getIconExtension

public java.lang.String getIconExtension()

return icon extension

getIconFilename

public java.lang.String getIconFilename()

return icon filename

getImageExtension

public java.lang.String getImageExtension()

return image extension

getImageFilename

public java.lang.String getImageFilename()

return image filename

getJarExtension

public java.lang.String getJarExtension()

Returns the JAR file extension.

getJarFilename

public java.lang.String getJarFilename()

return jar filename

getIcon

public javax.swing.ImageIcon getIcon()

Returns:

the icon

getIconAsImage

public java.awt.Image getIconAsImage()

Returns:

the icon as image

getImage

public java.awt.Image getImage()

Returns:

the image

getIdent

public PluginDescriptor.PluginIdent getIdent()

Returns:

the ident

getName

public java.lang.String getName()

Returns:

the name

getVersion

public Version getVersion()

Returns:

the version

getUrl

public java.lang.String getUrl()

Returns:

the url

getXmlUrl

public java.lang.String getXmlUrl()

Returns:

the url for xml file

getDesc

@Deprecated
public java.lang.String getDesc()

Deprecated. use getDescription() instead

Returns:

the desc

getDescription

public java.lang.String getDescription()

Returns:

the description

setXmlUrl

public void setXmlUrl(java.lang.String xmlUrl)

Parameters:

xmlUrl - the xmlUrl to set

setRepository

public void setRepository(RepositoryPreferences.RepositoryInfo repository)

Parameters:

repository - the repository to set

getJarUrl

public java.lang.String getJarUrl()

Returns:

the jarUrl

setJarUrl

public void setJarUrl(java.lang.String jarUrl)

Parameters:

jarUrl - the jarUrl to set

getImageUrl

public java.lang.String getImageUrl()

Returns:

the imageUrl

setImageUrl

public void setImageUrl(java.lang.String imageUrl)

Parameters:

imageUrl - the imageUrl to set

getIconUrl

public java.lang.String getIconUrl()

Returns:

the iconUrl

setIconUrl

public void setIconUrl(java.lang.String iconUrl)

Parameters:

iconUrl - the iconUrl to set

getAuthor

public java.lang.String getAuthor()

Returns the author's plugin name.

getWeb

public java.lang.String getWeb()

Returns the website url of this plugin.

getEmail

public java.lang.String getEmail()

Returns:

the email

getChangeLog

public java.lang.String getChangeLog()

Returns:

the changeLog

getChangesLog

@Deprecated
public java.lang.String getChangesLog()

Deprecated. Use getChangeLog() instead

getRequiredKernelVersion

public Version getRequiredKernelVersion()

Returns:

the requiredKernelVersion

isDescriptorLoaded

public boolean isDescriptorLoaded()

Returns true if descriptor is loaded.

isLoaded

@Deprecated
public boolean isLoaded()

Deprecated. Use isDescriptorLoaded() instead

isChangeLogLoaded

public boolean isChangeLogLoaded()

Returns true if change log is loaded.

isIconLoaded

public boolean isIconLoaded()

Returns true if icon is loaded.

isImageLoaded

public boolean isImageLoaded()

Returns true if image is loaded.

isImagesLoaded

public boolean isImagesLoaded()

Returns true if image and icon are loaded.

isAllLoaded

public boolean isAllLoaded()

Returns true if both descriptor and images are loaded.

getRequired

public java.util.List<PluginDescriptor.PluginIdent> getRequired()

Returns:

the required

getRepository

public RepositoryPreferences.RepositoryInfo getRepository()

isEnabled

public boolean isEnabled()

Returns:

the enabled

setEnabled

public void setEnabled(boolean enabled)

Parameters:

enabled - the enabled to set

isInstalled

public boolean isInstalled()

Return true if plugin is installed (corresponding JAR file exist)

setName

public void setName(java.lang.String name)

Parameters:

name - the name to set

setAuthor

public void setAuthor(java.lang.String author)

Parameters:

author - the author to set

setWeb

public void setWeb(java.lang.String web)

Parameters:

web - the web to set

setEmail

public void setEmail(java.lang.String email)

Parameters:

email - the email to set

setDescription

public void setDescription(java.lang.String desc)

Parameters:

desc - the description to set

setChangeLog

public void setChangeLog(java.lang.String value)

Parameters:

value - the changeLog to set

setChangesLog

@Deprecated
public void setChangesLog(java.lang.String value)

Deprecated. use setChangeLog(String)

requires

public boolean requires(PluginDescriptor plugin)

Return true if specified plugin is required by current plugin

isOlderOrEqual

public boolean isOlderOrEqual(PluginDescriptor plugin)

isOlder

public boolean isOlder(PluginDescriptor plugin)

isNewerOrEqual

public boolean isNewerOrEqual(PluginDescriptor plugin)

isNewer

public boolean isNewer(PluginDescriptor plugin)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object