com.nomagic.magicdraw.plugins

Class PluginDescriptor

java.lang.Object

com.nomagic.magicdraw.plugins.PluginDescriptor

@OpenApiAll
public class PluginDescriptor
extends java.lang.Object

The plugin descriptor class. Contains all information about plugin. This information is taken from plugin.xml file.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PluginDescriptor.ClassLookupStrategy Class lookup strategy.

Constructor Summary

Constructors

Constructor and Description
PluginDescriptor()

Method Summary

Methods

Modifier and Type	Method and Description
void	addHelpResource(com.nomagic.magicdraw.help.HelpResource helpResource) Add help resource.
void	addRequiredPlugin(java.lang.String pluginID, RequiredPlugin requiredPlugin) Adds record about required plugin.
PluginDescriptor.ClassLookupStrategy	getClassLookupStrategy() Get class lookup strategy.
java.lang.String	getClassName() Returns plugin class name.
java.util.List<com.nomagic.magicdraw.help.HelpResource>	getHelpResources() Returns plugin help resources.
java.lang.String	getID() Returns plugin id.
int	getInternalVersion() Returns plugin internal version number
java.lang.String	getLicenseID() Returns plugin license id.
java.lang.String	getName() Returns plugin name.
java.io.File	getPluginDirectory() Returns the plugin installation directory.
java.lang.String	getProvider() Returns plugin provider.
java.lang.String	getRequiresAPI() Returns the required MagicDraw Open API version.
java.util.Map<java.lang.String,RequiredPlugin>	getRequiresPlugins() Returns record about required plugins.
java.net.URL[]	getRuntimeLibraries() Returns an array of required jars for this plugin.
java.lang.String	getVersion() Return plugin version.
boolean	isEnabled() Returns true, if this plugin is enabled by user.
boolean	isLoaded() Returns true, if this plugin is loaded.
boolean	isSeparateClassloader() Checks if plugin needs separate classloader.
void	setClassLookupStrategy(PluginDescriptor.ClassLookupStrategy lookupStrategy) Set class lookup strategy.
void	setClassName(java.lang.String aClass) Sets plugin class name.
void	setEnabled(boolean enabled) Sets enabled flag.
void	setID(java.lang.String id) Sets plugin id.
void	setInternalVersion(int internalVersion) Sets plugin internal version number
void	setLicenseID(java.lang.String id) Sets plugin license id.
void	setLoaded(boolean loaded) Sets loaded flag.
void	setName(java.lang.String name) Sets the name of the plugin.
void	setPluginDirectory(java.io.File directory) Sets the plugin installation directory.
void	setProvider(java.lang.String provider) Sets plugin provider.
void	setRequiresAPI(java.lang.String version) Sets the required MagicDraw Open API version.
void	setRuntimeLibraries(java.net.URL[] libraries) Sets an array of required jars for this plugin.
void	setSeparateClassloader(boolean separateClassloader) Sets if use separate classloader.
void	setVersion(java.lang.String version) Sets the plugin version.
java.lang.String	toString() Provides some useful information about this class attributes.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginDescriptor

public PluginDescriptor()

Method Detail

setClassName

public void setClassName(java.lang.String aClass)

Sets plugin class name.

Parameters:

aClass - the plugin class name.

getClassName

public java.lang.String getClassName()

Returns plugin class name.

Returns:

plugin class name.

setID

public void setID(java.lang.String id)

Sets plugin id.

Parameters:

id - the plugin id.

getID

public java.lang.String getID()

Returns plugin id.

Returns:

plugins id.

setLicenseID

public void setLicenseID(java.lang.String id)

Sets plugin license id.

Parameters:

id - the plugin license id.

getLicenseID

public java.lang.String getLicenseID()

Returns plugin license id.

Returns:

plugins license id.

getInternalVersion

public int getInternalVersion()

Returns plugin internal version number

Returns:

internal version number

setInternalVersion

public void setInternalVersion(int internalVersion)

Sets plugin internal version number

Parameters:

internalVersion - plugin internal version number

setName

public void setName(java.lang.String name)

Sets the name of the plugin.

Parameters:

name - the plugin name.

getName

public java.lang.String getName()

Returns plugin name.

Returns:

name of the plugin.

setProvider

public void setProvider(java.lang.String provider)

Sets plugin provider.

Parameters:

provider - the plugin provider.

getProvider

public java.lang.String getProvider()

Returns plugin provider.

Returns:

the plugin provider name(company or person).

setRequiresAPI

public void setRequiresAPI(java.lang.String version)

Sets the required MagicDraw Open API version.

Parameters:

version - the required version number. Must be double.

getRequiresAPI

public java.lang.String getRequiresAPI()

Returns the required MagicDraw Open API version.

Returns:

the required version number.

setRuntimeLibraries

public void setRuntimeLibraries(java.net.URL[] libraries)

Sets an array of required jars for this plugin.

Parameters:

libraries - the array of required libraries.

getRuntimeLibraries

public java.net.URL[] getRuntimeLibraries()

Returns an array of required jars for this plugin.

Returns:

the array of required libraries.

setVersion

public void setVersion(java.lang.String version)

Sets the plugin version.

Parameters:

version - the plugin version.

getVersion

public java.lang.String getVersion()

Return plugin version.

Returns:

the plugin version.

setPluginDirectory

public void setPluginDirectory(java.io.File directory)

Sets the plugin installation directory. This is a directory there plugin descriptor xml file was found.

Parameters:

directory - the plugin directory.

getPluginDirectory

public java.io.File getPluginDirectory()

Returns the plugin installation directory. This is a directory there plugin descriptor xml file was found.

Returns:

the plugin directory.

getRequiresPlugins

public java.util.Map<java.lang.String,RequiredPlugin> getRequiresPlugins()

Returns record about required plugins.

Returns:

map of required plugins(key - plugin id, value - required plugin).

addRequiredPlugin

public void addRequiredPlugin(java.lang.String pluginID,
                     RequiredPlugin requiredPlugin)

Adds record about required plugin.

Parameters:

pluginID - the id of the plugin.

requiredPlugin - the required plugin descriptor

isEnabled

public boolean isEnabled()

Returns true, if this plugin is enabled by user.

Returns:

true, if this plugin is enabled by user.

setEnabled

public void setEnabled(boolean enabled)

Sets enabled flag.

Parameters:

enabled - the new value of enabled flag.

isLoaded

public boolean isLoaded()

Returns true, if this plugin is loaded.

Returns:

true, if this plugin is loaded.

setLoaded

public void setLoaded(boolean loaded)

Sets loaded flag.

Parameters:

loaded - the new value of loaded flag.

setSeparateClassloader

public void setSeparateClassloader(boolean separateClassloader)

Sets if use separate classloader.

Parameters:

separateClassloader - true if use separate classloader.

isSeparateClassloader

public boolean isSeparateClassloader()

Checks if plugin needs separate classloader.

Returns:

true if plugin needs separate classloader.

getHelpResources

public java.util.List<com.nomagic.magicdraw.help.HelpResource> getHelpResources()

Returns plugin help resources.

Returns:

help resource.

addHelpResource

public void addHelpResource(com.nomagic.magicdraw.help.HelpResource helpResource)

Add help resource.

Parameters:

helpResource - help resource.

getClassLookupStrategy

public PluginDescriptor.ClassLookupStrategy getClassLookupStrategy()

Get class lookup strategy.

Returns:

lookup strategy.

setClassLookupStrategy

public void setClassLookupStrategy(PluginDescriptor.ClassLookupStrategy lookupStrategy)

Set class lookup strategy.

Parameters:

lookupStrategy - lookup strategy.

toString

public java.lang.String toString()

Provides some useful information about this class attributes.

Overrides:

toString in class java.lang.Object

Returns:

the string representation.