icy.plugin.PluginDescriptor Class Reference

Inheritance diagram for icy.plugin.PluginDescriptor:

List of all members.

Classes
class	PluginClassNameSorter
class	PluginIdent
class	PluginNameSorter
Public Member Functions
	PluginDescriptor (Class<?extends Plugin > clazz)
	PluginDescriptor (String path) throws IllegalArgumentException
boolean	isInstanceOf (Class<?> containedClass)
boolean	isAbstract ()
boolean	isInterface ()
boolean	isActionable ()
boolean	isBeta ()
boolean	loadFromXML (String path)
boolean	loadFromXML (URL xmlUrl)
boolean	loadFromXML (Document document)
boolean	loadFromXML (Node node)
boolean	saveToXML ()
boolean	saveToXML (Node node)
boolean	isLoaded ()
String	getClassName ()
String	getSimpleClassName ()
String	getPackageName ()
String	getSimplePackageName ()
String	getAuthorPackageName ()
String	getClassAsString ()
Class<?extends Plugin >	getPluginClass ()
String	getFilename ()
String	getXMLExtension ()
String	getXMLFilename ()
String	getIconExtension ()
String	getIconFilename ()
String	getImageExtension ()
String	getImageFilename ()
String	getJarExtension ()
String	getJarFilename ()
ImageIcon	getIcon ()
Image	getIconAsImage ()
Image	getImage ()
PluginIdent	getIdent ()
String	getName ()
Version	getVersion ()
String	getUrlCurrent ()
String	getUrlStable ()
String	getUrlBeta ()
String	getXmlUrlStable ()
String	getXmlBetaUrl ()
String	getDesc ()
String	getJarUrl ()
void	setJarUrl (String jarUrl)
String	getImageUrl ()
void	setImageUrl (String imageUrl)
String	getIconUrl ()
void	setIconUrl (String iconUrl)
String	getAuthor ()
String	getWeb ()
String	getEmail ()
String	getChangesLog ()
List< PluginIdent >	getRequired ()
boolean	isEnabled ()
void	setEnabled (boolean enabled)
boolean	getHasUpdate ()
boolean	isCheckingForUpdate ()
PluginDescriptor	getOnlineDescriptor ()
boolean	isUpdateChecked ()
void	checkForUpdate ()
boolean	requires (PluginDescriptor plugin)
boolean	isOlderOrEqual (PluginDescriptor plugin)
boolean	isOlder (PluginDescriptor plugin)
boolean	isNewerOrEqual (PluginDescriptor plugin)
boolean	isNewer (PluginDescriptor plugin)
String	toString ()
boolean	equals (Object obj)
int	hashCode ()
Static Public Member Functions
static PluginDescriptor	getOnlinePlugin (PluginIdent ident)
static boolean	existInList (ArrayList< PluginDescriptor > list, PluginDescriptor plugin)
static boolean	existInList (ArrayList< PluginDescriptor > list, PluginIdent ident)
static void	addToList (ArrayList< PluginDescriptor > list, PluginDescriptor plugin)
static ArrayList < PluginDescriptor >	getPlugins (ArrayList< PluginDescriptor > list, String className)
static PluginDescriptor	getPlugin (ArrayList< PluginDescriptor > list, String className)
static PluginDescriptor	getPlugin (ArrayList< PluginDescriptor > list, PluginIdent ident, boolean acceptNewer)
Package Attributes
boolean	checkingForUpdate
boolean	updateChecked
PluginDescriptor	onlineDescriptor
Static Package Attributes
static final String	ID_CLASSNAME = "classname"

---

Detailed Description

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

See also:

PluginLauncher

Author:

Fabrice de Chaumont & Stephane

---

Constructor & Destructor Documentation

icy.plugin.PluginDescriptor.PluginDescriptor

(

Class<?extends Plugin >

clazz

)

Create from class, used for local plugin

icy.plugin.PluginDescriptor.PluginDescriptor

(

String

path

)

throws IllegalArgumentException

Create from XML file, used for online plugin only

Exceptions:

IllegalArgumentException

---

Member Function Documentation

void icy.plugin.PluginDescriptor.checkForUpdate

(

)

check for update (asynchronous as it can take sometime)

String icy.plugin.PluginDescriptor.getAuthor

(

)

Returns:

the author

String icy.plugin.PluginDescriptor.getAuthorPackageName

(

)

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

String icy.plugin.PluginDescriptor.getChangesLog

(

)

Returns:

the changesLog

String icy.plugin.PluginDescriptor.getClassAsString

(

)

Returns:

the pluginClass

String icy.plugin.PluginDescriptor.getDesc

(

)

Returns:

the desc

String icy.plugin.PluginDescriptor.getEmail

(

)

Returns:

the email

String icy.plugin.PluginDescriptor.getFilename

(

)

return associated filename

boolean icy.plugin.PluginDescriptor.getHasUpdate

(

)

Returns:

the hasUpdate

ImageIcon icy.plugin.PluginDescriptor.getIcon

(

)

Returns:

the icon

Image icy.plugin.PluginDescriptor.getIconAsImage

(

)

Returns:

the icon as image

String icy.plugin.PluginDescriptor.getIconExtension

(

)

return icon extension

String icy.plugin.PluginDescriptor.getIconFilename

(

)

return icon filename

String icy.plugin.PluginDescriptor.getIconUrl

(

)

Returns:

the iconUrl

PluginIdent icy.plugin.PluginDescriptor.getIdent

(

)

Returns:

the lastUse

Parameters:

lastUse

the lastUse to set

Returns:

the ident

Image icy.plugin.PluginDescriptor.getImage

(

)

Returns:

the image

String icy.plugin.PluginDescriptor.getImageExtension

(

)

return image extension

String icy.plugin.PluginDescriptor.getImageFilename

(

)

return image filename

String icy.plugin.PluginDescriptor.getImageUrl

(

)

Returns:

the imageUrl

String icy.plugin.PluginDescriptor.getJarExtension

(

)

return jar extension

String icy.plugin.PluginDescriptor.getJarFilename

(

)

return jar filename

String icy.plugin.PluginDescriptor.getJarUrl

(

)

Returns:

the jarUrl

String icy.plugin.PluginDescriptor.getName

(

)

Returns:

the name

PluginDescriptor icy.plugin.PluginDescriptor.getOnlineDescriptor

(

)

Returns:

the onlineDescriptor

static PluginDescriptor icy.plugin.PluginDescriptor.getOnlinePlugin

(

PluginIdent

ident

)

[static]

Get online plugin of specified PluginIdent
Take care of "allow beta" global flag
This method can take sometime !

Class<? extends Plugin> icy.plugin.PluginDescriptor.getPluginClass

(

)

Returns:

the pluginClass

List<PluginIdent> icy.plugin.PluginDescriptor.getRequired

(

)

Returns:

the menuTask

the menuBand return true if plugin is specified type

the classesName

the required

String icy.plugin.PluginDescriptor.getSimplePackageName

(

)

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

String icy.plugin.PluginDescriptor.getUrlBeta

(

)

Returns:

the beta url

String icy.plugin.PluginDescriptor.getUrlCurrent

(

)

Returns:

the url for current version

String icy.plugin.PluginDescriptor.getUrlStable

(

)

Returns:

the stable url

Version icy.plugin.PluginDescriptor.getVersion

(

)

Returns:

the version

String icy.plugin.PluginDescriptor.getWeb

(

)

Returns:

the web

String icy.plugin.PluginDescriptor.getXmlBetaUrl

(

)

Returns:

the url for beta xml file

String icy.plugin.PluginDescriptor.getXMLExtension

(

)

return xml extension

String icy.plugin.PluginDescriptor.getXMLFilename

(

)

return xml filename

String icy.plugin.PluginDescriptor.getXmlUrlStable

(

)

Returns:

the url for stable xml file

boolean icy.plugin.PluginDescriptor.isAbstract

(

)

Return true if the plugin class is abstract

boolean icy.plugin.PluginDescriptor.isActionable

(

)

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

boolean icy.plugin.PluginDescriptor.isBeta

(

)

Return true if the plugin is in beta state

boolean icy.plugin.PluginDescriptor.isCheckingForUpdate

(

)

Returns:

the checkingForUpdate

boolean icy.plugin.PluginDescriptor.isEnabled

(

)

Returns:

the enabled

boolean icy.plugin.PluginDescriptor.isInstanceOf

(

Class<?>

containedClass

)

Check if the given class is a subclass of the class contained in this descriptor.

Parameters:

containedClass

boolean icy.plugin.PluginDescriptor.isInterface

(

)

Return true if the plugin class is an interface

boolean icy.plugin.PluginDescriptor.isUpdateChecked

(

)

Returns:

the updateChecked

boolean icy.plugin.PluginDescriptor.loadFromXML

(

Node

node

)

LOAD

Implements icy.file.xml.XMLPersistent.

boolean icy.plugin.PluginDescriptor.requires

(

PluginDescriptor

plugin

)

Return true if specified plugin is required by current plugin

boolean icy.plugin.PluginDescriptor.saveToXML

(

Node

node

)

SAVE

Implements icy.file.xml.XMLPersistent.

void icy.plugin.PluginDescriptor.setEnabled

(

boolean

enabled

)

Parameters:

enabled

the enabled to set

void icy.plugin.PluginDescriptor.setIconUrl

(

String

iconUrl

)

Parameters:

iconUrl

the iconUrl to set

void icy.plugin.PluginDescriptor.setImageUrl

(

String

imageUrl

)

Parameters:

imageUrl

the imageUrl to set

void icy.plugin.PluginDescriptor.setJarUrl

(

String

jarUrl

)

Parameters:

jarUrl

the jarUrl to set

---

The documentation for this class was generated from the following file:

• C:/Documents and Settings/Administrator/quia2/ICY Kernel/icy/plugin/PluginDescriptor.java