org.craftercms.commons.plugin.model

Class Plugin

java.lang.Object

org.craftercms.commons.plugin.model.Plugin

public class Plugin
extends Object

Holds the metadata for a plugin

Since:

3.1.1

Author:

joseross

Field Summary

Fields

Modifier and Type	Field and Description
protected Build	build The build information of the plugin
protected List<String>	crafterCmsEditions The supported Crafter CMS editions of the plugin
protected List<Version>	crafterCmsVersions The supported Crafter CMS versions of the plugin
protected String	description The description of the plugin
protected Developer	developer The developer information of the plugin
protected String	id The unique id of the plugin
protected Link	license The license of the plugin
protected Media	media The media assets of the plugin
protected String	name The name of the plugin
protected List<Parameter>	parameters The parameters supported by the plugin
protected String	searchEngine The search engine required by the plugin
protected List<String>	tags The tags of the plugin
protected String	type The type of plugin
protected Version	version The version of the plugin
protected Link	website The website information of the plugin

Constructor Summary

Constructors

Constructor and Description
Plugin()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Build	getBuild()
List<String>	getCrafterCmsEditions()
List<Version>	getCrafterCmsVersions()
String	getDescription()
Developer	getDeveloper()
String	getId()
Link	getLicense()
Media	getMedia()
String	getName()
List<Parameter>	getParameters()
String	getSearchEngine()
List<String>	getTags()
String	getType()
Version	getVersion()
Link	getWebsite()
int	hashCode()
void	setBuild(Build build)
void	setCrafterCmsEditions(List<String> crafterCmsEditions)
void	setCrafterCmsVersions(List<Version> crafterCmsVersions)
void	setDescription(String description)
void	setDeveloper(Developer developer)
void	setId(String id)
void	setLicense(Link link)
void	setMedia(Media media)
void	setName(String name)
void	setParameters(List<Parameter> parameters)
void	setSearchEngine(String searchEngine)
void	setTags(List<String> tags)
void	setType(String type)
void	setVersion(Version version)
void	setWebsite(Link website)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

type

protected String type

The type of plugin

id

protected String id

The unique id of the plugin

name

protected String name

The name of the plugin

tags

protected List<String> tags

The tags of the plugin

version

protected Version version

The version of the plugin

description

protected String description

The description of the plugin

website

protected Link website

The website information of the plugin

media

protected Media media

The media assets of the plugin

developer

protected Developer developer

The developer information of the plugin

build

protected Build build

The build information of the plugin

license

protected Link license

The license of the plugin

crafterCmsEditions

protected List<String> crafterCmsEditions

The supported Crafter CMS editions of the plugin

crafterCmsVersions

protected List<Version> crafterCmsVersions

The supported Crafter CMS versions of the plugin

searchEngine

protected String searchEngine

The search engine required by the plugin

parameters

protected List<Parameter> parameters

The parameters supported by the plugin

Constructor Detail

Plugin

public Plugin()

Method Detail

getType

public String getType()

setType

public void setType(String type)

getId

public String getId()

setId

public void setId(String id)

getName

public String getName()

setName

public void setName(String name)

getTags

public List<String> getTags()

setTags

public void setTags(List<String> tags)

getVersion

public Version getVersion()

setVersion

public void setVersion(Version version)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getWebsite

public Link getWebsite()

setWebsite

public void setWebsite(Link website)

getMedia

public Media getMedia()

setMedia

public void setMedia(Media media)

getDeveloper

public Developer getDeveloper()

setDeveloper

public void setDeveloper(Developer developer)

getBuild

public Build getBuild()

setBuild

public void setBuild(Build build)

getLicense

public Link getLicense()

setLicense

public void setLicense(Link link)

getCrafterCmsEditions

public List<String> getCrafterCmsEditions()

setCrafterCmsEditions

public void setCrafterCmsEditions(List<String> crafterCmsEditions)

getCrafterCmsVersions

public List<Version> getCrafterCmsVersions()

setCrafterCmsVersions

public void setCrafterCmsVersions(List<Version> crafterCmsVersions)

getSearchEngine

public String getSearchEngine()

setSearchEngine

public void setSearchEngine(String searchEngine)

getParameters

public List<Parameter> getParameters()

setParameters

public void setParameters(List<Parameter> parameters)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object