Package com.cheetahdigital.locations.core.api

Class PlacesParams.Builder

java.lang.Object

com.cheetahdigital.corekit.rest.params.BaseParams.BaseBuilder<P,B>

com.cheetahdigital.corekit.rest.params.BaseListQueryParams.BaseListQueryBuilder<PlacesParams,PlacesParams.Builder>

com.cheetahdigital.locations.core.api.PlacesParams.Builder

Enclosing class:

PlacesParams

public static class PlacesParams.Builder
extends BaseListQueryParams.BaseListQueryBuilder<PlacesParams,PlacesParams.Builder>

Builder class for PlacesParams

Field Summary

Fields inherited from class com.cheetahdigital.corekit.rest.params.BaseParams.BaseBuilder

mQueryParams

Constructor Summary

Constructors

Constructor	Description
Builder()	Default constructor.
Builder(PlacesParams queryParams)	Create a builder class from an existing PlacesParams.

Method Summary

Modifier and Type	Method	Description
PlacesParams.Builder	addSubCategories(java.lang.String subCategories)	Add a sub category to filter the list
PlacesParams.Builder	addSubCategories(java.lang.String... subCategories)	Add sub categories to filter the list
PlacesParams	build()
protected PlacesParams	createQueryParams()	Instantiates the implementation class
PlacesParams.Builder	setAction(java.lang.String action)	Set region transition type
PlacesParams.Builder	setAddress(java.lang.String address)	Set place address
PlacesParams.Builder	setDistance(java.lang.Integer distance)	Set distance parameter in miles
PlacesParams.Builder	setIntegrationId(java.lang.String integrationId)	Set the integration id of the place
PlacesParams.Builder	setLatitude(java.lang.Double lat)	Set place latitude value
PlacesParams.Builder	setLongitude(java.lang.Double longitude)	Set place longitude value
PlacesParams.Builder	setQuery(java.lang.String query)	Set search parameter
PlacesParams.Builder	setUnit(java.lang.String unit)	Set unit used for searching place distance
PlacesParams.Builder	setWithClientEvents(java.lang.Boolean withClientEvents)	Sets the flag to show places with client events

Methods inherited from class com.cheetahdigital.corekit.rest.params.BaseListQueryParams.BaseListQueryBuilder

addCategories, addCategory, setItemsPerPage, setLayout, setPage, setSortBy, setSortOrder

Methods inherited from class com.cheetahdigital.corekit.rest.params.BaseParams.BaseBuilder

setId

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(PlacesParams queryParams)

Create a builder class from an existing PlacesParams. PlacesApiConstants.CLIENT_ID and PlacesApiConstants.CLIENT_SECRET are automatically added to BaseParams.BaseBuilder.mQueryParams if access token is null

Parameters:

queryParams - PlacesParams to be reused

Builder

public Builder()

Default constructor. PlacesApiConstants.CLIENT_ID and PlacesApiConstants.CLIENT_SECRET are automatically added to BaseParams.BaseBuilder.mQueryParams if access token is null

Method Detail

addSubCategories

public PlacesParams.Builder addSubCategories(@NonNull
                                             java.lang.String... subCategories)

Add sub categories to filter the list

Parameters:

subCategories - categories to filter

Returns:

The Builder object to allow for chaining calls to set/add methods

addSubCategories

public PlacesParams.Builder addSubCategories(@Nullable
                                             java.lang.String subCategories)

Add a sub category to filter the list

Parameters:

subCategories - category to filter

Returns:

The Builder object to allow for chaining calls to set/add methods

setQuery

public PlacesParams.Builder setQuery(@Nullable
                                     java.lang.String query)

Set search parameter

Parameters:

query - search parameter

Returns:

The Builder object to allow for chaining calls to set/add methods

setLatitude

public PlacesParams.Builder setLatitude(@Nullable
                                        java.lang.Double lat)

Set place latitude value

Parameters:

lat - place latitude value

Returns:

The Builder object to allow for chaining calls to set/add methods

setLongitude

public PlacesParams.Builder setLongitude(@Nullable
                                         java.lang.Double longitude)

Set place longitude value

Parameters:

longitude - place longitude value

Returns:

The Builder object to allow for chaining calls to set/add methods

setDistance

public PlacesParams.Builder setDistance(@Nullable
                                        java.lang.Integer distance)

Set distance parameter in miles

Parameters:

distance - Distance parameter in miles

Returns:

The Builder object to allow for chaining calls to set/add methods

setUnit

public PlacesParams.Builder setUnit(@Nullable
                                    java.lang.String unit)

Set unit used for searching place distance

Parameters:

unit - unit used for searching place distance

Returns:

The Builder object to allow for chaining calls to set/add methods

setAddress

public PlacesParams.Builder setAddress(@Nullable
                                       java.lang.String address)

Set place address

Parameters:

address - place address

Returns:

The Builder object to allow for chaining calls to set/add methods

setWithClientEvents

public PlacesParams.Builder setWithClientEvents(@Nullable
                                                java.lang.Boolean withClientEvents)

Sets the flag to show places with client events

Parameters:

withClientEvents - flag to show places with client events

Returns:

The Builder object to allow for chaining calls to set/add methods

setIntegrationId

public PlacesParams.Builder setIntegrationId(@Nullable
                                             java.lang.String integrationId)

Set the integration id of the place

Parameters:

integrationId - integration id of the place

Returns:

The Builder object to allow for chaining calls to set/add methods

setAction

public PlacesParams.Builder setAction(@Nullable
                                      java.lang.String action)

Set region transition type

Parameters:

action - region transition type

Returns:

The Builder object to allow for chaining calls to set/add methods

createQueryParams

protected PlacesParams createQueryParams()

Description copied from class: BaseParams.BaseBuilder

Instantiates the implementation class

Specified by:

createQueryParams in class BaseParams.BaseBuilder<PlacesParams,PlacesParams.Builder>

Returns:

implementation class of BaseParams.BaseBuilder

build

public PlacesParams build()

Overrides:

build in class BaseParams.BaseBuilder<PlacesParams,PlacesParams.Builder>

Returns:

the built parameter class