PluginDescriptor (T-Plan Robot Enterprise 7.0 Code Documentation)

java.lang.Object
- com.tplan.robot.plugin.PluginDescriptor

```
public class PluginDescriptor
extends Object
```
A plugin descriptor. It is typically stored as a JSON in the plugins/ folder.

Since:

7.0

T-Plan Robot Enterprise, (C) 2009-2022 T-Plan Limited. All rights reserved.

Constructor Summary

Constructors
Constructor and Description

PluginDescriptor()
Constructor to create an empty descriptor.

Constructors
Constructor and Description
`PluginDescriptor()` Constructor to create an empty descriptor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addArchitecture(String arch)`
`void`	`addFile(File file, File homeDir)`
`static PluginDescriptor`	`fromFolder(File folder)` Create a new plugin descriptor from a folder with the plugin files.
`static PluginDescriptor`	`fromZIP(File zip, boolean populateFiles)` Create a plugin descriptor from plugin files within a ZIP archive.
`List<String>`	`getArchitectures()`
`String`	`getDate()` Get the plugin release date.
`Date`	`getDateDate()` Get the plugin release date as the `Date` instance.
`Map<String,String>`	`getDependencies()`
`String`	`getDescription()` Get the plugin description for the current locale or the English one if the it is not available in the current current language.
`String`	`getDescription(String language)` Get description for the specified language.
`Map<String,String>`	`getDescriptions()` Get the map of localized plugin descriptions.
`Map<String,String>`	`getFiles()`
`String`	`getGroup()`
`String`	`getHelpLink()`
`String`	`getMainPath()`
`String`	`getMessageAfterInstall()`
`String`	`getMessageAfterInstall(String language)` Get message to be displayed after the installation for the specified language.
`String`	`getMessageBeforeDelete()`
`String`	`getMessageBeforeDelete(String language)`
`String`	`getMessageBeforeInstall()`
`String`	`getMessageBeforeInstall(String language)` Get message to be displayed before the installation for the specified language.
`String`	`getMessageBeforeUpdate()`
`String`	`getMessageBeforeUpdate(String language)` Get message to be displayed before the plugin update for the specified language.
`Map<String,String>`	`getMessagesAfterInstall()`
`Map<String,String>`	`getMessagesBeforeDelete()`
`Map<String,String>`	`getMessagesBeforeInstall()`
`Map<String,String>`	`getMessagesBeforeUpdate()`
`String`	`getMinimumRobotVersion()`
`String`	`getName()` Get the plugin name for the current locale or the English one if the it is not available in the current current language.
`String`	`getName(String language)` Get the plugin display name for the specified language.
`Map<String,String>`	`getNames()` Get the map of localized plugin names.
`String`	`getStartupRunnable()`
`String`	`getSupportContact()` Get the vendor's support contact.
`String`	`getTestClasses()`
`String`	`getUniqueId()` Get the plugin unique ID.
`String`	`getVendorHomePage()`
`String`	`getVendorName()`
`String`	`getVersion()` Get the plugin version.
`boolean`	`isCanDelete()`
`boolean`	`isCanUpdate()`
`boolean`	`isInstalledAsLegacyJAR(List<File> outFiles)`
`boolean`	`isLinux()`
`boolean`	`isMac()`
`boolean`	`isMacApp()`
`boolean`	`isRestartRequired()`
`boolean`	`isSupported(StringBuilder msg)`
`boolean`	`isWinApp()`
`boolean`	`isWindows()`
`void`	`remove(List<String> errors)` Uninstall (remove) the plugin.
`void`	`setArchitectures(List<String> architectures)`
`void`	`setCanDelete(boolean canDelete)`
`void`	`setCanUpdate(boolean canUpdate)`
`void`	`setDate(Date date)`
`void`	`setDate(String date)` Set the plugin release date.
`void`	`setDependencies(Map<String,String> dependencies)`
`void`	`setDescription(String description)`
`void`	`setDescription(String language, String description)`
`void`	`setDescriptions(Map<String,String> descriptions)`
`void`	`setFiles(Map<String,String> files)`
`void`	`setGroup(String group)`
`void`	`setHelpLink(String helpLink)`
`void`	`setLinux(boolean linux)`
`void`	`setMac(boolean mac)`
`void`	`setMacApp(boolean macApp)`
`void`	`setMainPath(String mainPath)`
`void`	`setMessageAfterInstall(String msg)`
`void`	`setMessageAfterInstall(String language, String msg)`
`void`	`setMessageBeforeDelete(String msg)`
`void`	`setMessageBeforeDelete(String language, String msg)`
`void`	`setMessageBeforeInstall(String msg)`
`void`	`setMessageBeforeInstall(String language, String msg)`
`void`	`setMessageBeforeUpdate(String msg)`
`void`	`setMessageBeforeUpdate(String language, String msg)`
`void`	`setMessagesAfterInstall(Map<String,String> messages)` Set the map of messages to be displayed after the installation.
`void`	`setMessagesBeforeDelete(Map<String,String> messages)` Set the map of messages to be displayed before plugin removal.
`void`	`setMessagesBeforeInstall(Map<String,String> messages)` Set the map of messages to be displayed prior to installation.
`void`	`setMessagesBeforeUpdate(Map<String,String> messages)` Set the map of messages to be displayed before the plugin update.
`void`	`setMinimumRobotVersion(String minimumRobotVersion)`
`void`	`setName(String name)`
`void`	`setName(String language, String name)`
`void`	`setNames(Map<String,String> descriptions)`
`void`	`setRestartRequired(boolean restartRequired)`
`void`	`setStartupRunnable(String startupRunnable)`
`void`	`setSupportContact(String supportContact)` Set the vendor's support contact.
`void`	`setTestClasses(String testClassses)`
`void`	`setUniqueId(String uniqueId)` Set the plugin unique ID.
`void`	`setVendorHomePage(String vendorHomePage)`
`void`	`setVendorName(String vendorName)`
`void`	`setVersion(String version)` Set the plugin version.
`void`	`setWinApp(boolean winApp)`
`void`	`setWindows(boolean windows)`
`String`	`toString()` Convert this instance to JSON.
`void`	`toZIP(File zip)` Write this descriptor into the argument plugin ZIP archive.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PluginDescriptor
```
public PluginDescriptor()
```
    Constructor to create an empty descriptor.
- Method Detail
  - fromFolder
```
public static PluginDescriptor fromFolder(File folder)
                                   throws IOException
```
    Create a new plugin descriptor from a folder with the plugin files.
    
    Parameters:
    
    folder - a plugin folder.
    
    Returns:
    
    a new plugin descriptor.
    
    Throws:
    
    IOException - on an I/O error.
  - fromZIP
```
public static PluginDescriptor fromZIP(File zip,
                                       boolean populateFiles)
                                throws IOException
```
    Create a plugin descriptor from plugin files within a ZIP archive.
    
    Parameters:
    
    zip - a ZIP archive with plugin files.
    
    populateFiles - true to create the "files" summary of files or false to skip.
    
    Returns:
    
    a new plugin descriptor.
    
    Throws:
    
    IOException - on an I/O error.
  - toString
```
public String toString()
```
    Convert this instance to JSON.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    JSON representation of this descriptor.
  - toZIP
```
public void toZIP(File zip)
           throws IOException
```
    Write this descriptor into the argument plugin ZIP archive.
    
    Parameters:
    
    zip - a plugin ZIP.
    
    Throws:
    
    IOException - on an I/O error.
  - getUniqueId
```
public String getUniqueId()
```
    Get the plugin unique ID.
    
    Returns:
    
    the unique ID.
  - setUniqueId
```
public void setUniqueId(String uniqueId)
```
    Set the plugin unique ID.
    
    Parameters:
    
    uniqueId - a unique ID for the plugin.
  - getVersion
```
public String getVersion()
```
    Get the plugin version.
    
    Returns:
    
    the version.
  - setVersion
```
public void setVersion(String version)
```
    Set the plugin version.
    
    Parameters:
    
    version - the version.
  - getName
```
public String getName()
```
    Get the plugin name for the current locale or the English one if the it is not available in the current current language.
    
    Returns:
    
    the plugin name.
  - getNames
```
public Map<String,String> getNames()
```
    Get the map of localized plugin names.
    
    Returns:
    
    the map of 2-char ISO-639-1 language codes and their corresponding names.
  - getName
```
public String getName(String language)
```
    Get the plugin display name for the specified language.
    
    Parameters:
    
    language - a 2-char ISO-639-1 language code.
    
    Returns:
    
    the plugin name for the specified language or the English one if the argument is null.
  - getDescriptions
```
public Map<String,String> getDescriptions()
```
    Get the map of localized plugin descriptions.
    
    Returns:
    
    the map of 2-char ISO-639-1 language codes and their corresponding descriptions.
  - getDescription
```
public String getDescription()
```
    Get the plugin description for the current locale or the English one if the it is not available in the current current language.
    
    Returns:
    
    the plugin description.
  - getDescription
```
public String getDescription(String language)
```
    Get description for the specified language.
    
    Parameters:
    
    language - a 2-char ISO-639-1 language code.
    
    Returns:
    
    the description for the argument language or English if the argument is null.
  - setDescriptions
```
public void setDescriptions(Map<String,String> descriptions)
```
    Parameters:
    
    descriptions - the descriptions to set
  - setDescription
```
public void setDescription(String description)
```
  - setDescription
```
public void setDescription(String language,
                           String description)
```
  - setNames
```
public void setNames(Map<String,String> descriptions)
```
    Parameters:
    
    descriptions - the descriptions to set
  - setName
```
public void setName(String name)
```
  - setName
```
public void setName(String language,
                    String name)
```
  - getVendorName
```
public String getVendorName()
```
    Returns:
    
    the vendorName
  - setVendorName
```
public void setVendorName(String vendorName)
```
    Parameters:
    
    vendorName - the vendorName to set
  - getVendorHomePage
```
public String getVendorHomePage()
```
    Returns:
    
    the vendorHomePage
  - setVendorHomePage
```
public void setVendorHomePage(String vendorHomePage)
```
    Parameters:
    
    vendorHomePage - the vendorHomePage to set
  - getMinimumRobotVersion
```
public String getMinimumRobotVersion()
```
    Returns:
    
    the minimumRobotVersion
  - setMinimumRobotVersion
```
public void setMinimumRobotVersion(String minimumRobotVersion)
```
    Parameters:
    
    minimumRobotVersion - the minimumRobotVersion to set
  - getMessagesBeforeInstall
```
public Map<String,String> getMessagesBeforeInstall()
```
    Returns:
    
    the descriptions
  - getMessageBeforeInstall
```
public String getMessageBeforeInstall(String language)
```
    Get message to be displayed before the installation for the specified language.
    
    Parameters:
    
    language - a 2-char ISO-639-1 language code.
    
    Returns:
    
    the message for the argument language or English if the argument is null.
  - setMessagesBeforeInstall
```
public void setMessagesBeforeInstall(Map<String,String> messages)
```
    Set the map of messages to be displayed prior to installation.
    
    Parameters:
    
    messages - map of messages where the key is a 2-char ISO-639-1 language code and the value is the message.
  - setMessageBeforeInstall
```
public void setMessageBeforeInstall(String msg)
```
  - setMessageBeforeInstall
```
public void setMessageBeforeInstall(String language,
                                    String msg)
```
  - getMessageBeforeInstall
```
public String getMessageBeforeInstall()
```
  - getMessageAfterInstall
```
public String getMessageAfterInstall()
```
  - getMessagesAfterInstall
```
public Map<String,String> getMessagesAfterInstall()
```
    Returns:
    
    the descriptions
  - getMessageAfterInstall
```
public String getMessageAfterInstall(String language)
```
    Get message to be displayed after the installation for the specified language.
    
    Parameters:
    
    language - a 2-char ISO-639-1 language code.
    
    Returns:
    
    the message for the argument language or English if the argument is null.
  - setMessagesAfterInstall
```
public void setMessagesAfterInstall(Map<String,String> messages)
```
    Set the map of messages to be displayed after the installation.
    
    Parameters:
    
    messages - map of messages where the key is a 2-char ISO-639-1 language code and the value is the message.
  - setMessageAfterInstall
```
public void setMessageAfterInstall(String msg)
```
  - setMessageAfterInstall
```
public void setMessageAfterInstall(String language,
                                   String msg)
```
  - getMessagesBeforeUpdate
```
public Map<String,String> getMessagesBeforeUpdate()
```
    Returns:
    
    the descriptions
  - getMessageBeforeUpdate
```
public String getMessageBeforeUpdate(String language)
```
    Get message to be displayed before the plugin update for the specified language.
    
    Parameters:
    
    language - a 2-char ISO-639-1 language code.
    
    Returns:
    
    the message for the argument language or English if the argument is null.
  - setMessagesBeforeUpdate
```
public void setMessagesBeforeUpdate(Map<String,String> messages)
```
    Set the map of messages to be displayed before the plugin update.
    
    Parameters:
    
    messages - map of messages where the key is a 2-char ISO-639-1 language code and the value is the message.
  - setMessageBeforeUpdate
```
public void setMessageBeforeUpdate(String msg)
```
  - setMessageBeforeUpdate
```
public void setMessageBeforeUpdate(String language,
                                   String msg)
```
  - getMessageBeforeUpdate
```
public String getMessageBeforeUpdate()
```
  - getMessagesBeforeDelete
```
public Map<String,String> getMessagesBeforeDelete()
```
  - getMessageBeforeDelete
```
public String getMessageBeforeDelete(String language)
```
    Parameters:
    
    language - a 2-char ISO-639-1 language code.
    
    Returns:
    
    the name
  - setMessagesBeforeDelete
```
public void setMessagesBeforeDelete(Map<String,String> messages)
```
    Set the map of messages to be displayed before plugin removal.
    
    Parameters:
    
    messages - map of messages where the key is a 2-char ISO-639-1 language code and the value is the message.
  - setMessageBeforeDelete
```
public void setMessageBeforeDelete(String msg)
```
  - setMessageBeforeDelete
```
public void setMessageBeforeDelete(String language,
                                   String msg)
```
  - getMessageBeforeDelete
```
public String getMessageBeforeDelete()
```
  - getSupportContact
```
public String getSupportContact()
```
    Get the vendor's support contact.
    
    Returns:
    
    the support contact
  - setSupportContact
```
public void setSupportContact(String supportContact)
```
    Set the vendor's support contact.
    
    Parameters:
    
    supportContact - the support contact to set.
  - getDate
```
public String getDate()
```
    Get the plugin release date.
    
    Returns:
    
    the release date.
  - setDate
```
public void setDate(String date)
```
    Set the plugin release date.
    
    Parameters:
    
    date - the release date to set.
  - getDateDate
```
public Date getDateDate()
                 throws ParseException
```
    Get the plugin release date as the Date instance.
    
    Returns:
    
    the plugin release date.
    
    Throws:
    
    ParseException - if the internal string representation of the date cannot be parsed.
  - setDate
```
public void setDate(Date date)
```
    Parameters:
    
    date - the date to set
  - isRestartRequired
```
public boolean isRestartRequired()
```
    Returns:
    
    the restartRequired
  - setRestartRequired
```
public void setRestartRequired(boolean restartRequired)
```
    Parameters:
    
    restartRequired - the restartRequired to set
  - getDependencies
```
public Map<String,String> getDependencies()
```
    Returns:
    
    the dependencies
  - setDependencies
```
public void setDependencies(Map<String,String> dependencies)
```
    Parameters:
    
    dependencies - the dependencies to set
  - isWindows
```
public boolean isWindows()
```
    Returns:
    
    the windows
  - setWindows
```
public void setWindows(boolean windows)
```
    Parameters:
    
    windows - the windows to set
  - isMac
```
public boolean isMac()
```
    Returns:
    
    the mac
  - setMac
```
public void setMac(boolean mac)
```
    Parameters:
    
    mac - the mac to set
  - isLinux
```
public boolean isLinux()
```
    Returns:
    
    the linux
  - setLinux
```
public void setLinux(boolean linux)
```
    Parameters:
    
    linux - the linux to set
  - getArchitectures
```
public List<String> getArchitectures()
```
    Returns:
    
    the architectures
  - setArchitectures
```
public void setArchitectures(List<String> architectures)
```
    Parameters:
    
    architectures - the architectures to set
  - addArchitecture
```
public void addArchitecture(String arch)
```
  - getFiles
```
public Map<String,String> getFiles()
```
    Returns:
    
    the files
  - setFiles
```
public void setFiles(Map<String,String> files)
```
    Parameters:
    
    files - the files to set
  - addFile
```
public void addFile(File file,
                    File homeDir)
             throws IOException
```
    Throws:
    
    IOException
  - getMainPath
```
public String getMainPath()
```
    Returns:
    
    the mainPath
  - setMainPath
```
public void setMainPath(String mainPath)
```
    Parameters:
    
    mainPath - the mainPath to set
  - getStartupRunnable
```
public String getStartupRunnable()
```
    Returns:
    
    the startupRunnable
  - setStartupRunnable
```
public void setStartupRunnable(String startupRunnable)
```
    Parameters:
    
    startupRunnable - the startupRunnable to set
  - getGroup
```
public String getGroup()
```
    Returns:
    
    the group
  - setGroup
```
public void setGroup(String group)
```
    Parameters:
    
    group - the group to set
  - remove
```
public void remove(List<String> errors)
```
    Uninstall (remove) the plugin.
    
    Parameters:
    
    errors - optional list for errors.
  - isCanUpdate
```
public boolean isCanUpdate()
```
    Returns:
    
    the canUpdate
  - setCanUpdate
```
public void setCanUpdate(boolean canUpdate)
```
    Parameters:
    
    canUpdate - the canUpdate to set
  - isCanDelete
```
public boolean isCanDelete()
```
    Returns:
    
    the canDelete
  - setCanDelete
```
public void setCanDelete(boolean canDelete)
```
    Parameters:
    
    canDelete - the canDelete to set
  - getTestClasses
```
public String getTestClasses()
```
    Returns:
    
    the testClasses
  - setTestClasses
```
public void setTestClasses(String testClassses)
```
    Parameters:
    
    testClassses - the testClasses to set
  - isInstalledAsLegacyJAR
```
public boolean isInstalledAsLegacyJAR(List<File> outFiles)
```
  - getHelpLink
```
public String getHelpLink()
```
    Returns:
    
    the helpLink
  - setHelpLink
```
public void setHelpLink(String helpLink)
```
    Parameters:
    
    helpLink - the helpLink to set
  - isSupported
```
public boolean isSupported(StringBuilder msg)
```
  - isWinApp
```
public boolean isWinApp()
```
    Returns:
    
    the winApp
  - setWinApp
```
public void setWinApp(boolean winApp)
```
    Parameters:
    
    winApp - the winApp to set
  - isMacApp
```
public boolean isMacApp()
```
    Returns:
    
    the macApp
  - setMacApp
```
public void setMacApp(boolean macApp)
```
    Parameters:
    
    macApp - the macApp to set

Class PluginDescriptor

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PluginDescriptor

Method Detail

fromFolder

fromZIP

toString

toZIP

getUniqueId

setUniqueId

getVersion

setVersion

getName

getNames

getName

getDescriptions

getDescription

getDescription

setDescriptions

setDescription

setDescription

setNames

setName

setName

getVendorName

setVendorName

getVendorHomePage

setVendorHomePage

getMinimumRobotVersion

setMinimumRobotVersion

getMessagesBeforeInstall

getMessageBeforeInstall

setMessagesBeforeInstall

setMessageBeforeInstall

setMessageBeforeInstall

getMessageBeforeInstall

getMessageAfterInstall

getMessagesAfterInstall

getMessageAfterInstall

setMessagesAfterInstall

setMessageAfterInstall

setMessageAfterInstall

getMessagesBeforeUpdate

getMessageBeforeUpdate

setMessagesBeforeUpdate

setMessageBeforeUpdate

setMessageBeforeUpdate

getMessageBeforeUpdate

getMessagesBeforeDelete

getMessageBeforeDelete

setMessagesBeforeDelete

setMessageBeforeDelete

setMessageBeforeDelete

getMessageBeforeDelete

getSupportContact

setSupportContact

getDate

setDate

getDateDate

setDate

isRestartRequired

setRestartRequired

getDependencies

setDependencies

isWindows

setWindows

isMac

setMac

isLinux

setLinux

getArchitectures

setArchitectures

addArchitecture

getFiles

setFiles

addFile

getMainPath