com.atlassian.marketplace.client.api

Class AddonVersionsQuery.Builder

java.lang.Object

com.atlassian.marketplace.client.api.AddonVersionsQuery.Builder

All Implemented Interfaces:

QueryBuilderProperties.AccessToken<AddonVersionsQuery.Builder>, QueryBuilderProperties.ApplicationCriteria<AddonVersionsQuery.Builder>, QueryBuilderProperties.Bounds<AddonVersionsQuery.Builder>, QueryBuilderProperties.Cost<AddonVersionsQuery.Builder>, QueryBuilderProperties.Hosting<AddonVersionsQuery.Builder>

Enclosing class:

AddonVersionsQuery

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

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

Constructor Summary

Constructors

Constructor and Description
AddonVersionsQuery.Builder()

Method Summary

Methods

Modifier and Type	Method and Description
AddonVersionsQuery.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.
AddonVersionsQuery.Builder	afterVersion(com.atlassian.fugue.Option<String> versionName) Specifies an existing version if you want to query versions that are later than that version.
AddonVersionsQuery.Builder	appBuildNumber(com.atlassian.fugue.Option<Integer> appBuildNumber) Restricts the query to add-ons that are compatible with the specified application version.
AddonVersionsQuery.Builder	application(com.atlassian.fugue.Option<ApplicationKey> application) Restricts the query to add-ons that are compatible with the specified application.
AddonVersionsQuery.Builder	bounds(QueryBounds bounds) Sets the starting offset and/or the maximum result page size for the query, from a QueryBounds instance.
AddonVersionsQuery	build() Returns an immutable AddonVersionsQuery based on the current builder properties.
AddonVersionsQuery.Builder	cost(com.atlassian.fugue.Option<Cost> cost) Restricts the query to add-ons/products that match the given Cost criteria.
AddonVersionsQuery.Builder	hosting(com.atlassian.fugue.Option<HostingType> hosting) Restricts the query to add-ons that support the given hosting type.

Methods inherited from class java.lang.Object

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

Constructor Detail

AddonVersionsQuery.Builder

public AddonVersionsQuery.Builder()

Method Detail

build

public AddonVersionsQuery build()

Returns an immutable AddonVersionsQuery based on the current builder properties.

accessToken

public AddonVersionsQuery.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<AddonVersionsQuery.Builder>

Parameters:

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

Returns:

the same query builder

See Also:

QueryProperties.AccessToken.getAccessToken()

application

public AddonVersionsQuery.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<AddonVersionsQuery.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 AddonVersionsQuery.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<AddonVersionsQuery.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)

cost

public AddonVersionsQuery.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<AddonVersionsQuery.Builder>

Parameters:

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

Returns:

the same query builder

hosting

public AddonVersionsQuery.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<AddonVersionsQuery.Builder>

Parameters:

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

Returns:

the same query builder

afterVersion

public AddonVersionsQuery.Builder afterVersion(com.atlassian.fugue.Option<String> versionName)

Specifies an existing version if you want to query versions that are later than that version.

Parameters:

versionName - the version string (for instance, "1.0") of an existing add-on version to restrict the query to versions later than this version, or Option.none() to remove any such restriction

Returns:

the same query builder

See Also:

AddonVersionsQuery.getAfterVersionName()

bounds

public AddonVersionsQuery.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<AddonVersionsQuery.Builder>

Parameters:

bounds - a QueryBounds specifying an offset and/or limit

Returns:

the same query builder