Distance
Stay organized with collections
Save and categorize content based on your preferences.
Represents the distance to a Message.
Nested Class Summary
| @interface |
Distance.Accuracy
|
Possible values for the accuracy of a distance
estimate. |
Public Method Summary
| abstract int |
|
| abstract int |
|
| abstract double |
getMeters()
The distance estimate, in meters.
|
Inherited Method Summary
From interface java.lang.Comparable
Fields
public static final Distance
UNKNOWN
Public Methods
public abstract int compareTo (Distance
other)
public abstract int getAccuracy ()
The accuracy of the distance estimate.
public abstract double
getMeters ()
The distance estimate, in meters.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-31 UTC.
[null,null,["Last updated 2024-10-31 UTC."],[[["\u003cp\u003e\u003ccode\u003eDistance\u003c/code\u003e represents the distance to a nearby \u003ccode\u003eMessage\u003c/code\u003e and implements \u003ccode\u003eComparable\u003c/code\u003e for distance comparison.\u003c/p\u003e\n"],["\u003cp\u003eIt provides methods to get the distance estimate in meters (\u003ccode\u003egetMeters()\u003c/code\u003e) and the accuracy of the estimate (\u003ccode\u003egetAccuracy()\u003c/code\u003e).\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003ecompareTo()\u003c/code\u003e method compares distances based solely on meters, ignoring accuracy, and treats \u003ccode\u003eUNKNOWN\u003c/code\u003e distances as equal.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eUNKNOWN\u003c/code\u003e represents an unknown distance with low accuracy and \u003ccode\u003eNaN\u003c/code\u003e meters.\u003c/p\u003e\n"]]],["The `Distance` interface represents the distance to a `Message`. It implements `Comparable` for comparison. Key actions involve retrieving distance information: `getMeters()` provides the distance in meters, and `getAccuracy()` specifies the accuracy of the estimate. The `compareTo()` method compares distances based solely on their meter values. `UNKNOWN` signifies an undefined distance with low accuracy and a `Double.NaN` value for meters. It also defines `Distance.Accuracy` which provides accuracy levels for the distance.\n"],null,["# Distance\n\npublic interface **Distance** implements [Comparable](//developer.android.com/reference/java/lang/Comparable.html)\\\u003c[Distance](/android/reference/com/google/android/gms/nearby/messages/Distance)\\\u003e \nRepresents the distance to a [Message](/android/reference/com/google/android/gms/nearby/messages/Message). \n\n##### See Also\n\n- [MessageListener.onDistanceChanged(Message, Distance)](/android/reference/com/google/android/gms/nearby/messages/MessageListener#onDistanceChanged(com.google.android.gms.nearby.messages.Message,%20com.google.android.gms.nearby.messages.Distance)) \n\n### Nested Class Summary\n\n|------------|---|---|----------------------------------------------------------|\n| @interface | [Distance.Accuracy](/android/reference/com/google/android/gms/nearby/messages/Distance.Accuracy) || Possible values for the accuracy of a distance estimate. |\n\n### Field Summary\n\n|----------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| public static final [Distance](/android/reference/com/google/android/gms/nearby/messages/Distance) | [UNKNOWN](/android/reference/com/google/android/gms/nearby/messages/Distance#UNKNOWN) | Represents an unknown distance, with accuracy = [Distance.Accuracy.LOW](/android/reference/com/google/android/gms/nearby/messages/Distance.Accuracy#LOW), and meters = [Double.NaN](//developer.android.com/reference/java/lang/Double.html#NaN). |\n\n### Public Method Summary\n\n|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| abstract int | [compareTo](/android/reference/com/google/android/gms/nearby/messages/Distance#compareTo(com.google.android.gms.nearby.messages.Distance))([Distance](/android/reference/com/google/android/gms/nearby/messages/Distance) other) Note: This compares only [getMeters()](/android/reference/com/google/android/gms/nearby/messages/Distance#getMeters()), not accuracy. |\n| abstract int | [getAccuracy](/android/reference/com/google/android/gms/nearby/messages/Distance#getAccuracy())() The accuracy of the distance estimate. |\n| abstract double | [getMeters](/android/reference/com/google/android/gms/nearby/messages/Distance#getMeters())() The distance estimate, in meters. |\n\n### Inherited Method Summary\n\nFrom interface java.lang.Comparable \n\n|--------------|------------------------------------------------------------------------------------------------|\n| abstract int | compareTo([Distance](/android/reference/com/google/android/gms/nearby/messages/Distance) arg0) |\n\nFields\n------\n\n#### public static final Distance\n**UNKNOWN**\n\nRepresents an unknown distance, with accuracy = [Distance.Accuracy.LOW](/android/reference/com/google/android/gms/nearby/messages/Distance.Accuracy#LOW),\nand meters = [Double.NaN](//developer.android.com/reference/java/lang/Double.html#NaN).\n\nPublic Methods\n--------------\n\n#### public abstract int **compareTo** ([Distance](/android/reference/com/google/android/gms/nearby/messages/Distance) other)\n\nNote: This compares only [getMeters()](/android/reference/com/google/android/gms/nearby/messages/Distance#getMeters()),\nnot accuracy. We also consider NaN == NaN, so that [UNKNOWN](/android/reference/com/google/android/gms/nearby/messages/Distance#UNKNOWN).equals([UNKNOWN](/android/reference/com/google/android/gms/nearby/messages/Distance#UNKNOWN)). \n\n#### public abstract int **getAccuracy** ()\n\nThe accuracy of the distance estimate. \n\n#### public abstract double\n**getMeters** ()\n\nThe distance estimate, in meters."]]