Class Plugin
java.lang.Object
org.craftercms.commons.plugin.model.Plugin
Holds the metadata for a plugin
- Since:
- 3.1.1
- Author:
- joseross
-
Field Summary
FieldsModifier and TypeFieldDescriptionThe supported CrafterCMS editions of the pluginThe supported CrafterCMS versions of the pluginprotected String
The description of the pluginprotected Developer
The developer information of the pluginprotected String
The URL for the documentationprotected String
The unique id of the pluginprotected List
<Installation> List of installations to perform for the pluginprotected Link
The license of the pluginprotected Media
The media assets of the pluginprotected String
The name of the pluginThe parameters supported by the pluginprotected String
The search engine required by the pluginThe tags of the pluginprotected String
The type of pluginprotected Version
The version of the pluginprotected Link
The website information of the plugin -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
getId()
getMedia()
getName()
getTags()
getType()
int
hashCode()
void
setCrafterCmsEditions
(List<String> crafterCmsEditions) void
setCrafterCmsVersions
(List<Version> crafterCmsVersions) void
setDescription
(String description) void
setDeveloper
(Developer developer) void
setDocumentation
(String documentation) void
void
setInstallation
(List<Installation> installation) void
setLicense
(Link link) void
void
void
setParameters
(List<Parameter> parameters) void
setSearchEngine
(String searchEngine) void
void
void
setVersion
(Version version) void
setWebsite
(Link website) toString()
-
Field Details
-
type
The type of plugin -
id
The unique id of the plugin -
name
The name of the plugin -
tags
The tags of the plugin -
version
The version of the plugin -
description
The description of the plugin -
website
The website information of the plugin -
media
The media assets of the plugin -
developer
The developer information of the plugin -
license
The license of the plugin -
crafterCmsEditions
The supported CrafterCMS editions of the plugin -
crafterCmsVersions
The supported CrafterCMS versions of the plugin -
searchEngine
The search engine required by the plugin -
parameters
The parameters supported by the plugin -
installation
List of installations to perform for the plugin -
documentation
The URL for the documentation
-
-
Constructor Details
-
Plugin
public Plugin()
-
-
Method Details
-
getType
-
setType
-
getId
-
setId
-
getName
-
setName
-
getTags
-
setTags
-
getVersion
-
setVersion
-
getDescription
-
setDescription
-
getWebsite
-
setWebsite
-
getMedia
-
setMedia
-
getDeveloper
-
setDeveloper
-
getLicense
-
setLicense
-
getCrafterCmsEditions
-
setCrafterCmsEditions
-
getCrafterCmsVersions
-
setCrafterCmsVersions
-
getSearchEngine
-
setSearchEngine
-
getParameters
-
setParameters
-
getInstallation
-
setInstallation
-
getDocumentation
-
setDocumentation
-
equals
-
hashCode
public int hashCode() -
toString
-