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 StringThe description of the pluginprotected DeveloperThe developer information of the pluginprotected StringThe URL for the documentationprotected StringThe unique id of the pluginprotected List<Installation> List of installations to perform for the pluginprotected LinkThe license of the pluginprotected MediaThe media assets of the pluginprotected StringThe name of the pluginThe parameters supported by the pluginprotected StringThe search engine required by the pluginThe tags of the pluginprotected StringThe type of pluginprotected VersionThe version of the pluginprotected LinkThe website information of the plugin -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleangetId()getMedia()getName()getTags()getType()inthashCode()voidsetCrafterCmsEditions(List<String> crafterCmsEditions) voidsetCrafterCmsVersions(List<Version> crafterCmsVersions) voidsetDescription(String description) voidsetDeveloper(Developer developer) voidsetDocumentation(String documentation) voidvoidsetInstallation(List<Installation> installation) voidsetLicense(Link link) voidvoidvoidsetParameters(List<Parameter> parameters) voidsetSearchEngine(String searchEngine) voidvoidvoidsetVersion(Version version) voidsetWebsite(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
-