com.atlassian.marketplace.client.api

Class AddonQuery.Builder

java.lang.Object

com.atlassian.marketplace.client.api.AddonQuery.Builder

All Implemented Interfaces:

QueryBuilderProperties.AccessToken<AddonQuery.Builder>, QueryBuilderProperties.ApplicationCriteria<AddonQuery.Builder>, QueryBuilderProperties.Bounds<AddonQuery.Builder>, QueryBuilderProperties.Cost<AddonQuery.Builder>, QueryBuilderProperties.Hosting<AddonQuery.Builder>, QueryBuilderProperties.WithVersion<AddonQuery.Builder>

Enclosing class:

AddonQuery

public static class AddonQuery.Builder
extends Object
implements QueryBuilderProperties.AccessToken<AddonQuery.Builder>, QueryBuilderProperties.ApplicationCriteria<AddonQuery.Builder>, QueryBuilderProperties.Bounds<AddonQuery.Builder>, QueryBuilderProperties.Cost<AddonQuery.Builder>, QueryBuilderProperties.Hosting<AddonQuery.Builder>, QueryBuilderProperties.WithVersion<AddonQuery.Builder>

Builder class for AddonQuery. Use AddonQuery.builder() to create an instance.

Constructor Summary

Constructors

Constructor and Description
AddonQuery.Builder()

Method Summary

Methods

Modifier and Type	Method and Description
AddonQuery.Builder	accessToken(com.atlassian.fugue.Option<String> accessToken) Optionally includes an access token in the query, allowing access to any private add-on that has such a token.
AddonQuery.Builder	appBuildNumber(com.atlassian.fugue.Option<Integer> appBuildNumber) Restricts the query to add-ons that are compatible with the specified application version.
AddonQuery.Builder	application(com.atlassian.fugue.Option<ApplicationKey> application) Restricts the query to add-ons that are compatible with the specified application.
AddonQuery.Builder	bounds(QueryBounds bounds) Sets the starting offset and/or the maximum result page size for the query, from a QueryBounds instance.
AddonQuery	build() Returns an immutable AddonQuery based on the current builder properties.
AddonQuery.Builder	categoryNames(Iterable<String> categoryNames) Restricts the query to add-ons that belong to one of the specified categories.
AddonQuery.Builder	cost(com.atlassian.fugue.Option<Cost> cost) Restricts the query to add-ons/products that match the given Cost criteria.
AddonQuery.Builder	forThisUserOnly(boolean forThisUserOnly) Specifies whether to query only the addons associated with the current authenticated user's vendor(s).
AddonQuery.Builder	hosting(com.atlassian.fugue.Option<HostingType> hosting) Restricts the query to add-ons that support the given hosting type.
AddonQuery.Builder	includeHidden(com.atlassian.fugue.Option<AddonQuery.IncludeHiddenType> includeHidden) Specifies whether to include special "hidden" add-ons in the results.
AddonQuery.Builder	includePrivate(boolean includePrivate) Specifies whether to include private add-ons in the results.
AddonQuery.Builder	label(com.atlassian.fugue.Option<String> label) Restricts the query to add-ons that have been tagged with the specified label string.
AddonQuery.Builder	searchText(com.atlassian.fugue.Option<String> searchText) Restricts the query to add-ons that have the specified text somewhere in their name or description.
AddonQuery.Builder	treatPartlyFreeAs(com.atlassian.fugue.Option<AddonQuery.TreatPartlyFreeAs> treatPartlyFreeAs) Specify how partly free, paid via Atlassian add-ons (those with a free tier) should be treated.
AddonQuery.Builder	view(com.atlassian.fugue.Option<AddonQuery.View> view) Specifies an AddonQuery.View which determines the overall sort order and/or subset of add-ons to be queried.
AddonQuery.Builder	withVersion(boolean withVersion) Specifies whether the result set should include version-level properties.

Methods inherited from class java.lang.Object

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

Constructor Detail

AddonQuery.Builder

public AddonQuery.Builder()

Method Detail

build

public AddonQuery build()

Returns an immutable AddonQuery based on the current builder properties.

accessToken

public AddonQuery.Builder accessToken(com.atlassian.fugue.Option<String> accessToken)

Description copied from interface: QueryBuilderProperties.AccessToken

Optionally includes an access token in the query, allowing access to any private add-on that has such a token.

Specified by:

accessToken in interface QueryBuilderProperties.AccessToken<AddonQuery.Builder>

Parameters:

accessToken - an access token string, or Option.none()

Returns:

the same query builder

See Also:

QueryProperties.AccessToken.getAccessToken()

application

public AddonQuery.Builder application(com.atlassian.fugue.Option<ApplicationKey> application)

Description copied from interface: QueryBuilderProperties.ApplicationCriteria

Restricts the query to add-ons that are compatible with the specified application.

Specified by:

application in interface QueryBuilderProperties.ApplicationCriteria<AddonQuery.Builder>

Parameters:

application - an ApplicationKey, or Option.none() for no application filter

Returns:

the same query builder

See Also:

QueryBuilderProperties.ApplicationCriteria.application(Option)

appBuildNumber

public AddonQuery.Builder appBuildNumber(com.atlassian.fugue.Option<Integer> appBuildNumber)

Description copied from interface: QueryBuilderProperties.ApplicationCriteria

Restricts the query to add-ons that are compatible with the specified application version. This is ignored if you have not specified QueryBuilderProperties.ApplicationCriteria.application(com.atlassian.fugue.Option<com.atlassian.marketplace.client.api.ApplicationKey>).

Specified by:

appBuildNumber in interface QueryBuilderProperties.ApplicationCriteria<AddonQuery.Builder>

Parameters:

appBuildNumber - the application build number, or Option.none() for no application version filter

Returns:

the same query builder

See Also:

QueryBuilderProperties.ApplicationCriteria.appBuildNumber(Option)

categoryNames

public AddonQuery.Builder categoryNames(Iterable<String> categoryNames)

Restricts the query to add-ons that belong to one of the specified categories. An empty list means there is no such restriction. To obtain a list of allowable category names, use AddonCategories.

Parameters:

categoryNames - category names to search for, or an empty Iterable if you do not want to filter by add-on category

Returns:

the same query builder

See Also:

AddonQuery.getCategoryNames()

cost

public AddonQuery.Builder cost(com.atlassian.fugue.Option<Cost> cost)

Description copied from interface: QueryBuilderProperties.Cost

Restricts the query to add-ons/products that match the given Cost criteria.

Specified by:

cost in interface QueryBuilderProperties.Cost<AddonQuery.Builder>

Parameters:

cost - a Cost value, or Option.none() for no cost filter

Returns:

the same query builder

forThisUserOnly

public AddonQuery.Builder forThisUserOnly(boolean forThisUserOnly)

Specifies whether to query only the addons associated with the current authenticated user's vendor(s).

Parameters:

forThisUserOnly - true to query only addons associated with the current authenticated user; false (the default) to query add-ons from any vendor.

Returns:

the same query builder

See Also:

AddonQuery.isForThisUserOnly()

hosting

public AddonQuery.Builder hosting(com.atlassian.fugue.Option<HostingType> hosting)

Description copied from interface: QueryBuilderProperties.Hosting

Restricts the query to add-ons that support the given hosting type.

Specified by:

hosting in interface QueryBuilderProperties.Hosting<AddonQuery.Builder>

Parameters:

hosting - a HostingType constant, or Option.none() for no hosting filter

Returns:

the same query builder

includeHidden

public AddonQuery.Builder includeHidden(com.atlassian.fugue.Option<AddonQuery.IncludeHiddenType> includeHidden)

Specifies whether to include special "hidden" add-ons in the results. These are not private listings; they are add-ons that Atlassian has configured to be invisible on the Marketplace site, but still discoverable from within applications under some circumstances (such as language packs).

Parameters:

includeHidden - the type of hidden add-ons to include, or Option.none() (the default) to exclude them all

Returns:

the same query builder

See Also:

AddonQuery.getIncludeHidden()

includePrivate

public AddonQuery.Builder includePrivate(boolean includePrivate)

Specifies whether to include private add-ons in the results. This will only have an effect if you are authenticated, and you will only be able to see private add-ons that you would be able to access in the Marketplace site (that is, unless you are a Marketplace administrator, only private add-ons from your vendor(s) will be accessible).

Parameters:

includePrivate - true to include private add-ons; false (the default) to include only public add-ons

Returns:

the same query builder

See Also:

AddonQuery.isIncludePrivate()

label

public AddonQuery.Builder label(com.atlassian.fugue.Option<String> label)

Restricts the query to add-ons that have been tagged with the specified label string. This is an internal identifier, not visible on the Marketplace site, that Atlassian administrators may use to create subsets of add-ons for any purpose.

Parameters:

label - label string to search for, or Option.none() for no label search

Returns:

the same query builder

See Also:

AddonQuery.getLabel()

treatPartlyFreeAs

public AddonQuery.Builder treatPartlyFreeAs(com.atlassian.fugue.Option<AddonQuery.TreatPartlyFreeAs> treatPartlyFreeAs)

Specify how partly free, paid via Atlassian add-ons (those with a free tier) should be treated. By default none is included.

Parameters:

treatPartlyFreeAs - how to treat partly free, PvA add-ons in queries

Returns:

the same query builder

searchText

public AddonQuery.Builder searchText(com.atlassian.fugue.Option<String> searchText)

Restricts the query to add-ons that have the specified text somewhere in their name or description.

Parameters:

searchText - text to search for, or Option.none() for no text search

Returns:

the same query builder

See Also:

AddonQuery.getSearchText()

view

public AddonQuery.Builder view(com.atlassian.fugue.Option<AddonQuery.View> view)

Specifies an AddonQuery.View which determines the overall sort order and/or subset of add-ons to be queried.

Parameters:

view - an AddonQuery.View value, or Option.none() for the default view

Returns:

the same query builder

See Also:

AddonQuery.getView()

withVersion

public AddonQuery.Builder withVersion(boolean withVersion)

Description copied from interface: QueryBuilderProperties.WithVersion

Specifies whether the result set should include version-level properties. This is false by default.

Specified by:

withVersion in interface QueryBuilderProperties.WithVersion<AddonQuery.Builder>

Parameters:

withVersion - true if the result set should include version data

Returns:

the same query builder

bounds

public AddonQuery.Builder bounds(QueryBounds bounds)

Description copied from interface: QueryBuilderProperties.Bounds

Sets the starting offset and/or the maximum result page size for the query, from a QueryBounds instance.

Specified by:

bounds in interface QueryBuilderProperties.Bounds<AddonQuery.Builder>

Parameters:

bounds - a QueryBounds specifying an offset and/or limit

Returns:

the same query builder