devplugin

Class PluginInfo

java.lang.Object

devplugin.PluginInfo

public final class PluginInfo
extends Object

This class provides information about a plugin.

Constructor Summary

Constructors

Constructor and Description
PluginInfo() Creates the default PluginVersion instance.
PluginInfo(Class caller, String name) Creates an instance of PluginInfo with the default values and the given name.
PluginInfo(Class caller, String name, String desc) Creates an instance of PluginInfo with the default values and the given name and description.
PluginInfo(Class caller, String name, String desc, String author) Creates an instance of PluginInfo with the default values and the given name, description and author.
PluginInfo(Class caller, String name, String desc, String author, String license) Creates an instance of PluginInfo with the default values and the given name, description, author, the help url and license.
PluginInfo(Class caller, String name, String desc, String author, String license, String helpUrl) Creates an instance of PluginInfo with the default values and the given name, description, author, the help url and license.
PluginInfo(String name) Deprecated. since 2.6 Use PluginInfo(Class, String) instead.
PluginInfo(String name, String desc) Deprecated. since 2.6 Use PluginInfo(Class, String, String) instead.
PluginInfo(String name, String desc, String author) Deprecated. since 2.6 Use PluginInfo(Class, String, String, String) instead.
PluginInfo(String name, String desc, String author, Version version) Deprecated. since 2.6 Use PluginInfo(Class, String, String, String) instead and if this is for a Plugin let your Plugin hide Plugin.getVersion().
PluginInfo(String name, String desc, String author, Version version, String license) Deprecated. since 2.6 Use PluginInfo(Class, String, String, String, String, String) instead and if this is for a Plugin let your Plugin hide Plugin.getVersion().

Method Summary

Methods

Modifier and Type	Method and Description
String	getAuthor() Gets the author of the plugin.
String	getDescription() Gets the description of the plugin.
String	getHelpUrl() Gets the help url for the plugin.
static String	getHelpUrl(String id) get the help URL (in the wiki) for a plugin
String	getLicense() Gets the license of the plugin.
String	getName() Gets the name of the plugin.
Version	getVersion() Gets the version of the plugin.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginInfo

public PluginInfo(String name)

Deprecated. since 2.6 Use PluginInfo(Class, String) instead.

Creates an instance of PluginInfo with the default values and the given name.

Parameters:

name - The name of the plugin.

PluginInfo

public PluginInfo(String name,
          String desc)

Deprecated. since 2.6 Use PluginInfo(Class, String, String) instead.

Creates an instance of PluginInfo with the default values and the given name and description.

Parameters:

name - The name of the plugin.

desc - The description for the plugin.

PluginInfo

public PluginInfo(String name,
          String desc,
          String author)

Deprecated. since 2.6 Use PluginInfo(Class, String, String, String) instead.

Creates an instance of PluginInfo with the default values and the given name, description and author.

Parameters:

name - The name of the plugin.

desc - The description for the plugin.

author - The author of the plugin.

PluginInfo

public PluginInfo(String name,
          String desc,
          String author,
          Version version)

Deprecated. since 2.6 Use PluginInfo(Class, String, String, String) instead and if this is for a Plugin let your Plugin hide Plugin.getVersion().

Creates an instance of PluginInfo with the default values and the given name, description, author and version.

Parameters:

name - The name of the plugin.

desc - The description for the plugin.

author - The author of the plugin.

version - The version of the plugin.

PluginInfo

public PluginInfo(String name,
          String desc,
          String author,
          Version version,
          String license)

Deprecated. since 2.6 Use PluginInfo(Class, String, String, String, String, String) instead and if this is for a Plugin let your Plugin hide Plugin.getVersion().

Creates an instance of PluginInfo with the default values and the given name, description, author, version and license.

Parameters:

name - The name of the plugin.

desc - The description for the plugin.

author - The author of the plugin.

version - The version of the plugin.

license - The lincense of the plugin.

PluginInfo

public PluginInfo()

Creates the default PluginVersion instance.

PluginInfo

public PluginInfo(Class caller,
          String name)

Creates an instance of PluginInfo with the default values and the given name. If the caller class is a Plugin/TvDataService it will be tried to get the version from the static method getVersion() of Plugin/AbstractTvDataService.

Parameters:

caller - The class that want to create this PluginInfo

name - The name of the plugin.

Since:

2.6

PluginInfo

public PluginInfo(Class caller,
          String name,
          String desc)

Creates an instance of PluginInfo with the default values and the given name and description. If the caller class is a Plugin/TvDataService it will be tried to get the version from the static method getVersion() of Plugin/AbstractTvDataService.

Parameters:

caller - The class that want to create this PluginInfo

name - The name of the plugin.

desc - The description for the plugin.

Since:

2.6

PluginInfo

public PluginInfo(Class caller,
          String name,
          String desc,
          String author)

Creates an instance of PluginInfo with the default values and the given name, description and author. If the caller class is a Plugin/TvDataService it will be tried to get the version from the static method getVersion() of Plugin/AbstractTvDataService.

Parameters:

caller - The class that want to create this PluginInfo

name - The name of the plugin.

desc - The description for the plugin.

author - The author of the plugin.

Since:

2.6

PluginInfo

public PluginInfo(Class caller,
          String name,
          String desc,
          String author,
          String license)

Creates an instance of PluginInfo with the default values and the given name, description, author, the help url and license. If the caller class is a Plugin/TvDataService it will be tried to get the version from the static method getVersion() of Plugin/AbstractTvDataService.

Parameters:

caller - The class that want to create this PluginInfo

name - The name of the plugin.

desc - The description for the plugin.

author - The author of the plugin.

license - The lincense of the plugin. since 2.6

PluginInfo

public PluginInfo(Class caller,
          String name,
          String desc,
          String author,
          String license,
          String helpUrl)

Creates an instance of PluginInfo with the default values and the given name, description, author, the help url and license. If the caller class is a Plugin/TvDataService it will be tried to get the version from the static method getVersion() of Plugin/AbstractTvDataService.

Parameters:

caller - The class that want to create this PluginInfo

name - The name of the plugin.

desc - The description for the plugin.

author - The author of the plugin.

helpUrl - The url where to find help for the plugin.

license - The lincense of the plugin. since 2.6

Method Detail

getName

public String getName()

Gets the name of the plugin.

Returns:

The name of the plugin.

getDescription

public String getDescription()

Gets the description of the plugin.

Returns:

The description for this plugin.

getAuthor

public String getAuthor()

Gets the author of the plugin.

Returns:

The author of the plugin.

getHelpUrl

public String getHelpUrl()

Gets the help url for the plugin.

Returns:

The help url for the plugin.

Since:

2.6

getVersion

public Version getVersion()

Gets the version of the plugin.

Returns:

The version of the plugin.

getLicense

public String getLicense()

Gets the license of the plugin.

Returns:

The license of the plugin.

getHelpUrl

public static String getHelpUrl(String id)

get the help URL (in the wiki) for a plugin

Parameters:

id - plugin id

Returns:

generic help URL

Since:

2.6.1