Package com.nomagic.magicdraw.jpython

Class PythonPluginDescriptor

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

  • Constructor Details

    • PythonPluginDescriptor

      public PythonPluginDescriptor()

  • Method Details

    • setScriptFileName

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

    • getScriptFileName

      public String getScriptFileName()
      Returns plugin script file name.
      Returns:
      plugin script file name.

    • setID

      public void setID(String id)
      Sets plugin id.
      Parameters:
      id - the plugin id.

    • getID

      public String getID()
      Returns plugin id.
      Returns:
      plugins id.

    • setName

      public void setName(String name)
      Sets the name of the plugin.
      Parameters:
      name - the plugin name.

    • getName

      public String getName()
      Returns plugin name.
      Returns:
      name of the plugin.

    • setProvider

      public void setProvider(String provider)
      Sets plugin provider.
      Parameters:
      provider - the plugin provider.

    • getProvider

      public String getProvider()
      Returns plugin provider.
      Returns:
      the plugin provider name(company or person).

    • setRequiresAPI

      public void setRequiresAPI(String version)
      Sets the required MagicDraw Open API version.
      Parameters:
      the - required version number. Must be parsable double.

    • getRequiresAPI

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

    • setVersion

      public void setVersion(String version)
      Sets the plugin version.
      Parameters:
      version - the plugin version.

    • getVersion

      public String getVersion()
      Return plugin version.
      Returns:
      the plugin version.

    • setPluginDirectory

      public void setPluginDirectory(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 File getPluginDirectory()
      Returns the plugin instalation directory. This is a directory there plugin descriptor xml file was found.
      Returns:
      the plugin directory.

    • toString

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