Package de.xima.fc.pluginstore

Class PluginStoreItem

java.lang.Object

de.xima.fc.pluginstore.PluginStoreItem

All Implemented Interfaces:

Serializable

public final class PluginStoreItem
extends Object
implements Serializable

Model for a single store items that is shown in the plugin store. The plugin store is available via the plugin menu page.

Since:

8.0.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PluginStoreItem.Builder	A builder for configuring a PluginStoreItem instance

Method Summary

Modifier and Type	Method	Description
static PluginStoreItem.Builder	builder()	Creates a new builder for configuring a store item instance.
String	getDescription()	Gets the localized, HTML description of the plugin.
long	getDownloadCount()	Gets the total number of downloads of the plugin.
List<GuiImage>	getImages()	Gets the list of images (e.g.
String	getInstalledVersionRange()	Gets the range of installed versions, if any.
String	getName()	Gets the localized name of the plugin.
String	getPluginKey()	Gets the plugin key of this plugin group.
EPluginStoreItemInstallScope	getScope()	Gets the scope of the plugin.
String	getShortDescription()	Gets the short localized, plain-text description of the plugin.
EPluginStoreItemInstallStatus	getStatus()	Gets the install status of the plugin.
List<PluginStoreItemTag>	getTags()	Gets all tags associated with the plugin.
String	getTagsJson()
String	getVersion()	Gets the name of the most recent compatible version of the plugin.
boolean	isDowngrade()	Checks whether the plugin must be downgrade if installed.
boolean	isFree()	Gets if the plugin is freely available.
boolean	isInstallable()	Checks whether the plugin can be installed, depending on its getStatus().
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getDescription

public String getDescription()

Gets the localized, HTML description of the plugin.

Returns:

The description of the plugin.

getDownloadCount

public long getDownloadCount()

Gets the total number of downloads of the plugin.

Returns:

The number of plugin downloads.

getImages

public List<GuiImage> getImages()

Gets the list of images (e.g. icons or screenshots) for the plugin.

Returns:

A list with all image links.

getInstalledVersionRange

public String getInstalledVersionRange()

Gets the range of installed versions, if any.

Returns:

The range of installed versions.

getName

public String getName()

Gets the localized name of the plugin.

Returns:

The name of the plugin.

getPluginKey

public String getPluginKey()

Gets the plugin key of this plugin group.

Returns:

The key of the plugin group.

getShortDescription

public String getShortDescription()

Gets the short localized, plain-text description of the plugin.

Returns:

The short description of the plugin.

getStatus

public EPluginStoreItemInstallStatus getStatus()

Gets the install status of the plugin.

Returns:

The install status of the plugin.

getTags

public List<PluginStoreItemTag> getTags()

Gets all tags associated with the plugin.

Returns:

A list of tags, may be empty.

getTagsJson

public String getTagsJson()

getVersion

public String getVersion()

Gets the name of the most recent compatible version of the plugin.

Returns:

Version of the plugin.

getScope

public EPluginStoreItemInstallScope getScope()

Gets the scope of the plugin.

Returns:

The scope of the plugin.

isFree

public boolean isFree()

Gets if the plugin is freely available.

Returns:

if the plugin is freely available.

isDowngrade

public boolean isDowngrade()

Checks whether the plugin must be downgrade if installed.

Returns:

Whether installing the plugin is a downgrade.

isInstallable

public boolean isInstallable()

Checks whether the plugin can be installed, depending on its getStatus().

Returns:

Whether the plugin can be installed.

toString

public String toString()

Overrides:

toString in class Object

builder

public static PluginStoreItem.Builder builder()

Creates a new builder for configuring a store item instance.

Returns:

A new builder for a store item.