public final class

PlaceFilter

extends Object
implements Parcelable
java.lang.Object
   ↳ com.google.android.gms.location.places.PlaceFilter

Class Overview

Specifies constraints to use for filtering the results of some API methods.

Summary

[Expand]
Inherited Constants
From interface android.os.Parcelable
Public Constructors
PlaceFilter()
Creates a new PlaceFilter without any constraints.
PlaceFilter(boolean requireOpenNow, Collection<String> restrictToPlaceIds)
Creates a new PlaceFilter with the given constraints.
Public Methods
Set<String> getPlaceIds()
Returns the set of place IDs that this filter will allow.
boolean isRestrictedToPlacesOpenNow()
Checks whether or not this filter will allow only places that are currently open.
boolean matches(Place place)
Checks whether the given Place matches the constraints specified in this filter.
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.os.Parcelable

Public Constructors

public PlaceFilter ()

Creates a new PlaceFilter without any constraints.

A filter without constraints will not filter any results.

public PlaceFilter (boolean requireOpenNow, Collection<String> restrictToPlaceIds)

Creates a new PlaceFilter with the given constraints.

Places may be filtered by whether or not they are currently open, or by specific place IDs. For more information on place IDs, see the developer's guide.

Parameters
requireOpenNow boolean: Whether or not to restrict the results to places which are currently open.
restrictToPlaceIds Collection: The place IDs that this filter should allow. If this is specified, only places corresponding to the given IDs will be returned. If null, no filtering by place IDs will be done.

Public Methods

public Set<String> getPlaceIds ()

Returns the set of place IDs that this filter will allow.

Returns
Set<String> The set of place IDs allowed by this filter, or an empty set if no filtering by place IDs will be done.

public boolean isRestrictedToPlacesOpenNow ()

Checks whether or not this filter will allow only places that are currently open.

Returns
boolean True if only open places are allowed; false if otherwise.

public boolean matches (Place place)

Checks whether the given Place matches the constraints specified in this filter.

Parameters
place Place
Returns
boolean True if the place is allowed by the filter; false if otherwise.