com.atlassian.marketplace.client.model

Class AddonVersion

java.lang.Object

com.atlassian.marketplace.client.model.AddonVersionBase

com.atlassian.marketplace.client.model.AddonVersion

All Implemented Interfaces:

Entity

public final class AddonVersion
extends AddonVersionBase

Information about a specific version of an Addon.

Since:

2.0.0

See Also:

Addons, AddonVersionSummary

Constructor Summary

Constructors

Constructor and Description
AddonVersion()

Method Summary

Methods

Modifier and Type	Method and Description
com.atlassian.fugue.Option<ArtifactInfo>	getArtifactInfo() Details about the installable file for this add-on, if it has one that is hosted by Marketplace.
com.atlassian.fugue.Option<URI>	getArtifactUri() Shortcut for getting the download URI for the add-on's installable file, if any.
int	getBuildNumber() The version's build number, a value specified by the vendor (or, in the case of Atlassian Connect add-ons, set automatically by Marketplace) that distinguishes it from all other versions of the add-on and determines the correct ordering of versions.
Iterable<VersionCompatibility>	getCompatibilities() A list of VersionCompatibility objects representing each of the Applications the add-on version is compatible with, and the compatible application version range.
com.atlassian.fugue.Option<Iterable<VersionCompatibility>>	getCompatibilitiesIfSpecified() Same as getCompatibilities(), but returns none() rather than an empty list if this is a new version that you are creating which has no compatibilities specified (meaning that it will inherit its compatibilities from the previous version).
Iterable<ApplicationKey>	getCompatibleApplications() Returns just the application keys from the list of compatibilities.
com.atlassian.fugue.Option<URI>	getExternalLinkUri(AddonVersionExternalLinkType type) Returns one of the optional vendor-specified external links for the add-on version.
Iterable<AddonCategorySummary>	getFunctionalCategories() Returns summaries of all functional categories that this add-on version belongs to.
Iterable<Highlight>	getHighlights() The image/text "highlight" items that are featured in a public add-on listing; may be omitted for private versions.
com.atlassian.fugue.Option<Iterable<Highlight>>	getHighlightsIfSpecified() Same as getHighlights(), but returns none() rather than an empty list if this is a new version that you are creating which has no highlights specified (meaning that it will inherit its highlights from the previous version).
com.atlassian.fugue.Option<LicenseType>	getLicenseType() Information about the add-on version's software license type; may be omitted for private versions.
com.atlassian.fugue.Option<LicenseTypeId>	getLicenseTypeId() The unique resource identifier for the add-on version's software license type; may be omitted for private versions.
com.atlassian.fugue.Option<HtmlString>	getMoreDetails() Optional descriptive text to be displayed in the add-on listing.
PaymentModel	getPaymentModel() Indicates whether the version is free, paid via Atlassian, or paid via Vendor.
com.atlassian.fugue.Option<HtmlString>	getReleaseNotes() Optional details about this release of the add-on (for instance, new features).
com.atlassian.fugue.Option<String>	getReleaseSummary() A brief description of the nature or purpose of this release (for instance, "bug fixes").
com.atlassian.fugue.Option<URI>	getRemoteDescriptorUri() Shortcut for getting the remote Atlassian Connect descriptor URI for the add-on, if any.
Iterable<Screenshot>	getScreenshots() Screenshot images with optional captions.
com.atlassian.fugue.Option<Iterable<Screenshot>>	getScreenshotsIfSpecified() Same as getScreenshots(), but returns none() rather than an empty list if this is a new version that you are creating which has no screenshots specified (meaning that it will inherit its screenshots from the previous version).
AddonVersionStatus	getStatus() Indicates whether the version is public, private, or pending approval.
com.atlassian.fugue.Option<String>	getYoutubeId() The string key of a YouTube video to be featured in the add-on listing.
boolean	isCompatibleWith(com.google.common.base.Predicate<ApplicationKey> applicationCriteria, HostingType hostingType, int build) Shortcut for testing whether the version is compatible with the specified application build and hosting type.
boolean	isCompatibleWithApplication(ApplicationKey application) Shortcut for testing whether the version has any compatibility with the specified application.
boolean	isStatic() True if this is a static add-on (Plugins 1, a deprecated add-on framework).

Methods inherited from class com.atlassian.marketplace.client.model.AddonVersionBase

getConnectScopes, getFunctionalCategoryIds, getLinks, getName, getReleaseDate, getReleasedBy, getSelfUri, isAutoUpdateAllowed, isBeta, isCloud, isConnect, isDataCenterCompatible, isDeployable, isServer, isSupported

Methods inherited from class java.lang.Object

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

Constructor Detail

AddonVersion

public AddonVersion()

Method Detail

getArtifactInfo

public com.atlassian.fugue.Option<ArtifactInfo> getArtifactInfo()

Description copied from class: AddonVersionBase

Details about the installable file for this add-on, if it has one that is hosted by Marketplace.

Specified by:

getArtifactInfo in class AddonVersionBase

See Also:

ModelBuilders.AddonVersionBuilder.artifact(Option)

getArtifactUri

public com.atlassian.fugue.Option<URI> getArtifactUri()

Description copied from class: AddonVersionBase

Shortcut for getting the download URI for the add-on's installable file, if any.

Specified by:

getArtifactUri in class AddonVersionBase

See Also:

AddonVersionBase.getArtifactInfo()

getRemoteDescriptorUri

public com.atlassian.fugue.Option<URI> getRemoteDescriptorUri()

Description copied from class: AddonVersionBase

Shortcut for getting the remote Atlassian Connect descriptor URI for the add-on, if any.

Specified by:

getRemoteDescriptorUri in class AddonVersionBase

See Also:

AddonVersionBase.getArtifactInfo()

getBuildNumber

public int getBuildNumber()

The version's build number, a value specified by the vendor (or, in the case of Atlassian Connect add-ons, set automatically by Marketplace) that distinguishes it from all other versions of the add-on and determines the correct ordering of versions.

See Also:

ModelBuilders.AddonVersionBuilder.buildNumber

getCompatibilities

public Iterable<VersionCompatibility> getCompatibilities()

A list of VersionCompatibility objects representing each of the Applications the add-on version is compatible with, and the compatible application version range. For an existing add-on listing, there will always be at least one of these.

See Also:

getCompatibilitiesIfSpecified()

getCompatibilitiesIfSpecified

public com.atlassian.fugue.Option<Iterable<VersionCompatibility>> getCompatibilitiesIfSpecified()

Same as getCompatibilities(), but returns none() rather than an empty list if this is a new version that you are creating which has no compatibilities specified (meaning that it will inherit its compatibilities from the previous version).

getExternalLinkUri

public com.atlassian.fugue.Option<URI> getExternalLinkUri(AddonVersionExternalLinkType type)

Returns one of the optional vendor-specified external links for the add-on version.

Parameters:

type - specifies which type of link to get

Returns:

the link URI, or Option.none() if there is no such link

getFunctionalCategories

public Iterable<AddonCategorySummary> getFunctionalCategories()

Description copied from class: AddonVersionBase

Returns summaries of all functional categories that this add-on version belongs to. A functional category - unlike the logical categories returned by AddonBase.getCategories() - describes a specific kind of feature integration based on the software structure of the add-on (for instance, the types of modules it provides); this is computed by Marketplace, not set by the vendor. Examples of functional categories include macros in Confluence and workflows in JIRA.

Specified by:

getFunctionalCategories in class AddonVersionBase

getHighlights

public Iterable<Highlight> getHighlights()

The image/text "highlight" items that are featured in a public add-on listing; may be omitted for private versions.

See Also:

getHighlightsIfSpecified(), ModelBuilders.AddonVersionBuilder.highlights(Iterable)

getHighlightsIfSpecified

public com.atlassian.fugue.Option<Iterable<Highlight>> getHighlightsIfSpecified()

Same as getHighlights(), but returns none() rather than an empty list if this is a new version that you are creating which has no highlights specified (meaning that it will inherit its highlights from the previous version).

getLicenseType

public com.atlassian.fugue.Option<LicenseType> getLicenseType()

Information about the add-on version's software license type; may be omitted for private versions.

See Also:

ModelBuilders.AddonVersionBuilder.licenseType(Option), getLicenseTypeId()

getLicenseTypeId

public com.atlassian.fugue.Option<LicenseTypeId> getLicenseTypeId()

The unique resource identifier for the add-on version's software license type; may be omitted for private versions.

Overrides:

getLicenseTypeId in class AddonVersionBase

See Also:

ModelBuilders.AddonVersionBuilder.licenseTypeId(Option), getLicenseType()

getMoreDetails

public com.atlassian.fugue.Option<HtmlString> getMoreDetails()

Optional descriptive text to be displayed in the add-on listing.

See Also:

ModelBuilders.AddonVersionBuilder.moreDetails(Option)

getPaymentModel

public PaymentModel getPaymentModel()

Description copied from class: AddonVersionBase

Indicates whether the version is free, paid via Atlassian, or paid via Vendor. ModelBuilders.AddonVersionBuilder.paymentModel(PaymentModel)

Overrides:

getPaymentModel in class AddonVersionBase

getReleaseNotes

public com.atlassian.fugue.Option<HtmlString> getReleaseNotes()

Optional details about this release of the add-on (for instance, new features).

See Also:

ModelBuilders.AddonVersionBuilder.releaseNotes(Option)

getReleaseSummary

public com.atlassian.fugue.Option<String> getReleaseSummary()

A brief description of the nature or purpose of this release (for instance, "bug fixes").

See Also:

ModelBuilders.AddonVersionBuilder.releaseSummary(Option)

getScreenshots

public Iterable<Screenshot> getScreenshots()

Screenshot images with optional captions.

See Also:

getScreenshotsIfSpecified(), ModelBuilders.AddonVersionBuilder.screenshots(Iterable)

getScreenshotsIfSpecified

public com.atlassian.fugue.Option<Iterable<Screenshot>> getScreenshotsIfSpecified()

Same as getScreenshots(), but returns none() rather than an empty list if this is a new version that you are creating which has no screenshots specified (meaning that it will inherit its screenshots from the previous version).

getStatus

public AddonVersionStatus getStatus()

Description copied from class: AddonVersionBase

Indicates whether the version is public, private, or pending approval. ModelBuilders.AddonVersionBuilder.status(AddonVersionStatus)

Overrides:

getStatus in class AddonVersionBase

isStatic

public boolean isStatic()

Description copied from class: AddonVersionBase

True if this is a static add-on (Plugins 1, a deprecated add-on framework).

Overrides:

isStatic in class AddonVersionBase

getYoutubeId

public com.atlassian.fugue.Option<String> getYoutubeId()

The string key of a YouTube video to be featured in the add-on listing.

See Also:

ModelBuilders.AddonVersionBuilder.youtubeId(Option)

getCompatibleApplications

public Iterable<ApplicationKey> getCompatibleApplications()

Returns just the application keys from the list of compatibilities.

See Also:

getCompatibilities()

isCompatibleWithApplication

public boolean isCompatibleWithApplication(ApplicationKey application)

Shortcut for testing whether the version has any compatibility with the specified application.

See Also:

getCompatibilities()

isCompatibleWith

public boolean isCompatibleWith(com.google.common.base.Predicate<ApplicationKey> applicationCriteria,
                       HostingType hostingType,
                       int build)

Shortcut for testing whether the version is compatible with the specified application build and hosting type.

See Also:

getCompatibilities()