Package org.pf4j
Class DefaultPluginDescriptor
- java.lang.Object
-
- org.pf4j.DefaultPluginDescriptor
-
- All Implemented Interfaces:
PluginDescriptor
public class DefaultPluginDescriptor extends java.lang.Object implements PluginDescriptor
-
-
Field Summary
Fields Modifier and Type Field Description private java.util.List<PluginDependency>
dependencies
private java.lang.String
license
private java.lang.String
pluginClass
private java.lang.String
pluginDescription
private java.lang.String
pluginId
private java.lang.String
provider
private java.lang.String
requires
private java.lang.String
version
-
Constructor Summary
Constructors Constructor Description DefaultPluginDescriptor()
DefaultPluginDescriptor(java.lang.String pluginId, java.lang.String pluginDescription, java.lang.String pluginClass, java.lang.String version, java.lang.String requires, java.lang.String provider, java.lang.String license)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addDependency(PluginDependency dependency)
java.util.List<PluginDependency>
getDependencies()
Returns all dependencies declared by this plugin.java.lang.String
getLicense()
Returns the legal license of this plugin, e.g.java.lang.String
getPluginClass()
Returns the name of the class that implements Plugin interface.java.lang.String
getPluginDescription()
Returns the description of this plugin.java.lang.String
getPluginId()
Returns the unique identifier of this plugin.java.lang.String
getProvider()
Returns the provider name of this plugin.java.lang.String
getRequires()
Returns string version of requiresjava.lang.String
getVersion()
Returns the version of this plugin.protected PluginDescriptor
setDependencies(java.lang.String dependencies)
PluginDescriptor
setLicense(java.lang.String license)
protected PluginDescriptor
setPluginClass(java.lang.String pluginClassName)
protected PluginDescriptor
setPluginDescription(java.lang.String pluginDescription)
protected DefaultPluginDescriptor
setPluginId(java.lang.String pluginId)
protected DefaultPluginDescriptor
setPluginVersion(java.lang.String version)
protected PluginDescriptor
setProvider(java.lang.String provider)
protected PluginDescriptor
setRequires(java.lang.String requires)
java.lang.String
toString()
-
-
-
Field Detail
-
pluginId
private java.lang.String pluginId
-
pluginDescription
private java.lang.String pluginDescription
-
pluginClass
private java.lang.String pluginClass
-
version
private java.lang.String version
-
requires
private java.lang.String requires
-
provider
private java.lang.String provider
-
dependencies
private java.util.List<PluginDependency> dependencies
-
license
private java.lang.String license
-
-
Constructor Detail
-
DefaultPluginDescriptor
public DefaultPluginDescriptor()
-
DefaultPluginDescriptor
public DefaultPluginDescriptor(java.lang.String pluginId, java.lang.String pluginDescription, java.lang.String pluginClass, java.lang.String version, java.lang.String requires, java.lang.String provider, java.lang.String license)
-
-
Method Detail
-
addDependency
public void addDependency(PluginDependency dependency)
-
getPluginId
public java.lang.String getPluginId()
Returns the unique identifier of this plugin.- Specified by:
getPluginId
in interfacePluginDescriptor
-
getPluginDescription
public java.lang.String getPluginDescription()
Returns the description of this plugin.- Specified by:
getPluginDescription
in interfacePluginDescriptor
-
getPluginClass
public java.lang.String getPluginClass()
Returns the name of the class that implements Plugin interface.- Specified by:
getPluginClass
in interfacePluginDescriptor
-
getVersion
public java.lang.String getVersion()
Returns the version of this plugin.- Specified by:
getVersion
in interfacePluginDescriptor
-
getRequires
public java.lang.String getRequires()
Returns string version of requires- Specified by:
getRequires
in interfacePluginDescriptor
- Returns:
- String with requires expression on SemVer format
-
getProvider
public java.lang.String getProvider()
Returns the provider name of this plugin.- Specified by:
getProvider
in interfacePluginDescriptor
-
getLicense
public java.lang.String getLicense()
Returns the legal license of this plugin, e.g. "Apache-2.0", "MIT" etc- Specified by:
getLicense
in interfacePluginDescriptor
-
getDependencies
public java.util.List<PluginDependency> getDependencies()
Returns all dependencies declared by this plugin. Returns an empty array if this plugin does not declare any require.- Specified by:
getDependencies
in interfacePluginDescriptor
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
setPluginId
protected DefaultPluginDescriptor setPluginId(java.lang.String pluginId)
-
setPluginDescription
protected PluginDescriptor setPluginDescription(java.lang.String pluginDescription)
-
setPluginClass
protected PluginDescriptor setPluginClass(java.lang.String pluginClassName)
-
setPluginVersion
protected DefaultPluginDescriptor setPluginVersion(java.lang.String version)
-
setProvider
protected PluginDescriptor setProvider(java.lang.String provider)
-
setRequires
protected PluginDescriptor setRequires(java.lang.String requires)
-
setDependencies
protected PluginDescriptor setDependencies(java.lang.String dependencies)
-
setLicense
public PluginDescriptor setLicense(java.lang.String license)
-
-