public class PluginMetadataHelper extends Object
Constructor and Description |
---|
PluginMetadataHelper() |
Modifier and Type | Method and Description |
---|---|
static String |
getAuthor(java.nio.file.Path pluginDir)
Returns the author of a plugin.
|
static String |
getAuthor(Plugin plugin)
Returns the author of a plugin.
|
static String |
getCanonicalName(java.nio.file.Path pluginPath)
Returns the canonical name for the plugin, derived from the plugin directory or archive file name.
|
static String |
getCanonicalName(Plugin plugin)
Returns the canonical name for the plugin, derived from the plugin archive file name.
|
static URL |
getChangelog(java.nio.file.Path pluginDir) |
static URL |
getChangelog(Plugin plugin) |
static String |
getDatabaseKey(java.nio.file.Path pluginDir)
Returns the database schema key of a plugin, if it exists.
|
static String |
getDatabaseKey(Plugin plugin)
Returns the database schema key of a plugin, if it exists.
|
static int |
getDatabaseVersion(java.nio.file.Path pluginDir)
Returns the database schema version of a plugin, if it exists.
|
static int |
getDatabaseVersion(Plugin plugin)
Returns the database schema version of a plugin, if it exists.
|
static String |
getDescription(java.nio.file.Path pluginDir)
Returns the description of a plugin.
|
static String |
getDescription(Plugin plugin)
Returns the description of a plugin.
|
static URL |
getIcon(java.nio.file.Path pluginDir) |
static URL |
getIcon(Plugin plugin) |
static String |
getLicense(java.nio.file.Path pluginDir)
Returns the license agreement type that the plugin is governed by.
|
static String |
getLicense(Plugin plugin)
Returns the license agreement type that the plugin is governed by.
|
static JavaSpecVersion |
getMinJavaVersion(java.nio.file.Path pluginDir)
Returns the minimum Java specification version this plugin needs to run.
|
static JavaSpecVersion |
getMinJavaVersion(Plugin plugin)
Returns the minimum Java specification version this plugin needs to run.
|
static Version |
getMinServerVersion(java.nio.file.Path pluginDir)
Returns the minimum server version this plugin can run within.
|
static Version |
getMinServerVersion(Plugin plugin)
Returns the minimum server version this plugin can run within.
|
static String |
getName(java.nio.file.Path pluginDir)
Returns the name of a plugin.
|
static String |
getName(Plugin plugin)
Returns the name of a plugin.
|
static String |
getParentPlugin(java.nio.file.Path pluginDir)
Returns the name of the directory of the parent for this plugin.
|
static String |
getParentPlugin(Plugin plugin)
Returns the name of the directory of the parent for this plugin.
|
static Version |
getPriorToServerVersion(java.nio.file.Path pluginDir)
Returns the server version up, but not including, in which this plugin can run within.
|
static Version |
getPriorToServerVersion(Plugin plugin)
Returns the server version up, but not including, in which this plugin can run within.
|
static URL |
getReadme(java.nio.file.Path pluginDir) |
static URL |
getReadme(Plugin plugin) |
static Version |
getVersion(java.nio.file.Path pluginDir)
Returns the version of a plugin.
|
static Version |
getVersion(Plugin plugin)
Returns the version of a plugin.
|
public static String getParentPlugin(Plugin plugin)
plugin
- The plugin (cannot be null)public static String getParentPlugin(java.nio.file.Path pluginDir)
pluginDir
- the path of the plugin directory.public static String getCanonicalName(Plugin plugin)
getName(Path)
.
Note that this method will return data only for plugins that have successfully been installed. To obtain data
from plugin (directories) that have not (yet) been installed, refer to the overloaded method that takes a Path
argument.plugin
- The plugin (cannot be null)public static String getCanonicalName(java.nio.file.Path pluginPath)
getName(Path)
.pluginPath
- the path of the plugin directory, or plugin archive file.public static String getName(Plugin plugin)
getCanonicalName(Path)
.
Note that this method will return data only for plugins that have successfully been installed. To obtain data
from plugin (directories) that have not (yet) been installed, refer to the overloaded method that takes a Path
argument.plugin
- The plugin (cannot be null)public static String getName(java.nio.file.Path pluginDir)
getCanonicalName(Path)
.pluginDir
- the path of the plugin directory.public static String getDescription(Plugin plugin)
plugin
- The plugin (cannot be null)public static String getDescription(java.nio.file.Path pluginDir)
pluginDir
- the path of the plugin directory.public static String getAuthor(Plugin plugin)
plugin
- The plugin (cannot be null)public static String getAuthor(java.nio.file.Path pluginDir)
pluginDir
- the path of the plugin directory.public static Version getVersion(Plugin plugin)
plugin
- The plugin (cannot be null)public static Version getVersion(java.nio.file.Path pluginDir)
pluginDir
- the path of the plugin directory.public static Version getMinServerVersion(Plugin plugin)
plugin
- The plugin (cannot be null)public static Version getMinServerVersion(java.nio.file.Path pluginDir)
pluginDir
- the path of the plugin directory.public static Version getPriorToServerVersion(Plugin plugin)
plugin
- The plugin (cannot be null)public static Version getPriorToServerVersion(java.nio.file.Path pluginDir)
pluginDir
- the path of the plugin directory.public static JavaSpecVersion getMinJavaVersion(Plugin plugin)
plugin
- The plugin (cannot be null)public static JavaSpecVersion getMinJavaVersion(java.nio.file.Path pluginDir)
pluginDir
- the path of the plugin directory.public static String getDatabaseKey(Plugin plugin)
plugin
- The plugin (cannot be null)public static String getDatabaseKey(java.nio.file.Path pluginDir)
pluginDir
- the path of the plugin directory.public static int getDatabaseVersion(Plugin plugin)
plugin
- The plugin (cannot be null)public static int getDatabaseVersion(java.nio.file.Path pluginDir)
pluginDir
- the path of the plugin directory.public static String getLicense(Plugin plugin)
plugin
- The plugin (cannot be null)public static String getLicense(java.nio.file.Path pluginDir)
pluginDir
- the path of the plugin directory.public static URL getIcon(java.nio.file.Path pluginDir)
public static URL getReadme(java.nio.file.Path pluginDir)
public static URL getChangelog(java.nio.file.Path pluginDir)
Copyright © 2003-2008 Jive Software.