Package org.graffiti.managers.pluginmgr
Class PluginDescription
java.lang.Object
org.graffiti.managers.pluginmgr.PluginDescription
public class PluginDescription extends Object
Contains a meta data of a plugin.
- Version:
- $Revision: 1.16 $
-
Constructor Summary
Constructors Constructor Description PluginDescription()Constructs an empty plugin description, -
Method Summary
Modifier and Type Method Description voidaddChild(PluginEntry plugin)voidaddDependency(PluginDependency dep)Adds the given dependency to the list of dependencies.voidaddPluginDependency(PluginDependency dep)Adds the given plugin dependency to the list of dependencies.StringgetAuthor()Returns the author.StringgetAvailable()Returns the available.Collection<PluginEntry>getChildPlugins()StringgetCompatibleVersion()Returns the version for compatibility.List<PluginDependency>getDependencies()Returns the dependencies.StringgetDescription()Returns the description.RSSfeedDefinitiongetFeed()StringgetMain()Returns the main.StringgetName()Returns the name.Iterator<PluginDependency>getPluginDependenciesIterator()Returns an iterator over the plugin dependency list.StringgetVersion()Returns the version.booleanhasRSSfeedDefined()booleanisAddon()booleanisOptional()booleanisOptionalDefaultTrue()booleanisPriorityPlugin()voidsetAddon(boolean isAddon)voidsetAuthor(String author)Sets the author.voidsetAvailable(String available)Sets the available.voidsetCompatibleVersion(String v)Sets the version for compatibility.voidsetDependencies(List<PluginDependency> dependencies)Sets the dependencies.voidsetDescription(String description)Sets the description.voidsetIsOptional(String optional)voidsetIsOptionalDefaultTrue(String optionalDefaultValue)voidsetIsPriorityPlugin(String priority)voidsetMain(String main)Sets the main.voidsetName(String name)Sets the name.voidsetRSSfeedName(String name)voidsetRSSfeedURL(String url)voidsetVersion(String version)Sets the version.StringtoString()Returns a human readable string representation of this object.
-
Constructor Details
-
PluginDescription
public PluginDescription()Constructs an empty plugin description,
-
-
Method Details
-
setAuthor
Sets the author.- Parameters:
author- The author to set
-
getAuthor
Returns the author.- Returns:
- String
-
setAvailable
Sets the available.- Parameters:
available- The available to set
-
getAvailable
Returns the available.- Returns:
- String
-
setDependencies
Sets the dependencies.- Parameters:
dependencies- The dependencies to set
-
getDependencies
Returns the dependencies.- Returns:
- List
-
setDescription
Sets the description.- Parameters:
description- The description to set
-
getDescription
Returns the description.- Returns:
- String
-
setMain
Sets the main.- Parameters:
main- The main to set
-
getMain
Returns the main.- Returns:
- String
-
setName
Sets the name.- Parameters:
name- The name to set
-
getName
Returns the name.- Returns:
- String
-
getPluginDependenciesIterator
Returns an iterator over the plugin dependency list.- Returns:
- an iterator over the plugin dependency list.
-
setVersion
Sets the version.- Parameters:
version- The version to set
-
getVersion
Returns the version.- Returns:
- Version
-
setCompatibleVersion
Sets the version for compatibility.- Parameters:
version- The version to set
-
getCompatibleVersion
Returns the version for compatibility.- Returns:
- Version
-
addDependency
Adds the given dependency to the list of dependencies.- Parameters:
dep- the dependency to add to the list of dependent plugins.
-
addPluginDependency
Adds the given plugin dependency to the list of dependencies.- Parameters:
dep- the dependency to add to the list.
-
toString
Returns a human readable string representation of this object. -
isAddon
public boolean isAddon() -
setAddon
public void setAddon(boolean isAddon) -
addChild
-
getChildPlugins
-
setIsOptional
-
isOptional
public boolean isOptional() -
setIsOptionalDefaultTrue
-
isOptionalDefaultTrue
public boolean isOptionalDefaultTrue() -
isPriorityPlugin
public boolean isPriorityPlugin() -
setIsPriorityPlugin
-
hasRSSfeedDefined
public boolean hasRSSfeedDefined() -
getFeed
- Returns:
- Null, if no feed is defined.
-
setRSSfeedName
-
setRSSfeedURL
-