com.atlassian.marketplace.client.api

Class ProductQuery.Builder

java.lang.Object

com.atlassian.marketplace.client.api.ProductQuery.Builder

All Implemented Interfaces:

QueryBuilderProperties.ApplicationCriteria<ProductQuery.Builder>, QueryBuilderProperties.Bounds<ProductQuery.Builder>, QueryBuilderProperties.Cost<ProductQuery.Builder>, QueryBuilderProperties.Hosting<ProductQuery.Builder>, QueryBuilderProperties.WithVersion<ProductQuery.Builder>

Enclosing class:

ProductQuery

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

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

Constructor Summary

Constructors

Constructor and Description
ProductQuery.Builder()

Method Summary

Methods

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

ProductQuery.Builder

public ProductQuery.Builder()

Method Detail

build

public ProductQuery build()

Returns an immutable ProductQuery based on the current builder properties.

application

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

Parameters:

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

Returns:

the same query builder

hosting

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

Parameters:

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

Returns:

the same query builder

withVersion

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

Parameters:

withVersion - true if the result set should include version data

Returns:

the same query builder

bounds

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

Parameters:

bounds - a QueryBounds specifying an offset and/or limit

Returns:

the same query builder