Package com.nomagic.magicdraw.jpython

Class PythonPluginDescriptor

  • @OpenApiAll
public class PythonPluginDescriptor
extends java.lang.Object
    The plugin descriptor class. Contains all information about plugin. This information is taken from plugin.xml file.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.String mID
      The plugin id.
      private java.lang.String mName
      The plugin name.
      private java.io.File mPluginDirectory
      The plugin instalation directory.
      private java.lang.String mProvider
      The plugin provider name.
      private java.lang.String mRequiresAPI
      Version of MagicDraw plugin requires.
      private java.lang.String mScriptFileName
      The plugin script file.
      private java.lang.String mVersion
      The plugin version.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getID()
      Returns plugin id.
      java.lang.String getName()
      Returns plugin name.
      java.io.File getPluginDirectory()
      Returns the plugin instalation directory.
      java.lang.String getProvider()
      Returns plugin provider.
      java.lang.String getRequiresAPI()
      Returns the required MagicDraw Open API version.
      java.lang.String getScriptFileName()
      Returns plugin script file name.
      java.lang.String getVersion()
      Return plugin version.
      void setID​(java.lang.String id)
      Sets plugin id.
      void setName​(java.lang.String name)
      Sets the name of the plugin.
      void setPluginDirectory​(java.io.File directory)
      Sets the plugin instalation directory.
      void setProvider​(java.lang.String provider)
      Sets plugin provider.
      void setRequiresAPI​(java.lang.String version)
      Sets the required MagicDraw Open API version.
      void setScriptFileName​(java.lang.String aScriptFile)
      Sets plugin scruot file name.
      void setVersion​(java.lang.String version)
      Sets the plugin version.
      java.lang.String toString()
      Provides some usefull information about this class attributes.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • mPluginDirectory

        private java.io.File mPluginDirectory
        The plugin instalation directory.

      • mID

        private java.lang.String mID
        The plugin id.

      • mName

        private java.lang.String mName
        The plugin name.

      • mVersion

        private java.lang.String mVersion
        The plugin version.

      • mProvider

        private java.lang.String mProvider
        The plugin provider name.

      • mRequiresAPI

        private java.lang.String mRequiresAPI
        Version of MagicDraw plugin requires. If API version is smaller, plugin will not be loaded.

      • mScriptFileName

        private java.lang.String mScriptFileName
        The plugin script file.

    • Constructor Detail

      • PythonPluginDescriptor

        public PythonPluginDescriptor()

    • Method Detail

      • setScriptFileName

        public void setScriptFileName​(java.lang.String aScriptFile)
        Sets plugin scruot file name.
        Parameters:
        aClass - the plugin script file name.

      • getScriptFileName

        public java.lang.String getScriptFileName()
        Returns plugin script file name.
        Returns:
        plugin script file 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.

      • 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:
        the - required version number. Must be parsable double.

      • getRequiresAPI

        public java.lang.String getRequiresAPI()
        Returns the required MagicDraw Open API version.
        Returns:
        the required version number.

      • 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 instalation 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 instalation directory. This is a directory there plugin descriptor xml file was found.
        Returns:
        the plugin directory.

      • toString

        public java.lang.String toString()
        Provides some usefull information about this class attributes.
        Overrides:
        toString in class java.lang.Object
        Returns:
        the string representation.