PlaceLikelihoodBuffer

public class PlaceLikelihoodBuffer extends AbstractDataBuffer<PlaceLikelihood>
implements Result

Data structure providing access to a list of PlaceLikelihood objects.

A PlaceLikelihoodBuffer contains a number of candidate Places, as well as an associated likelihood that each Place represents the correct location. For more information, see the developer's guide.

The likelihoods in a given PlaceLikelihoodBuffer may not sum to 1.0.

NOTE: The calling application must release() this object after it is done with it to prevent a memory leak. Refer to the developer's guide for more information about handling buffers.

Public Method Summary

PlaceLikelihood
get(int position)
Get the item at the specified position.
CharSequence
getAttributions()
Returns the attributions to be shown to the user.
Status
getStatus()
Returns the status of this result.

Inherited Method Summary

Public Methods

public PlaceLikelihood get (int position)

Get the item at the specified position. Note that the objects returned from subsequent invocations of this method for the same position may not be identical objects, but will be equal in value. In other words:

buffer.get(i) == buffer.get(i) may return false.

buffer.get(i).equals(buffer.get(i)) will return true.

Parameters
position The position of the item to retrieve.
Returns
  • the item at position in this buffer.

public CharSequence getAttributions ()

Returns the attributions to be shown to the user.

These are aggregated attributions for all the places in the buffer.

We recommend placing this information below any place information. See Displaying Attributions for more details.

Returns
  • The attributions in HTML format, or null if there are none.

public Status getStatus ()

Returns the status of this result. Use isSuccess() to determine whether the call was successful, and getStatusCode() to determine what the error cause was.

Certain errors are due to failures that can be resolved by launching a particular intent. The resolution intent is available via getResolution().