Stay organized with collections
Save and categorize content based on your preferences.
Length
class Length : Comparable<Length!>
Represents a unit of length. Supported units: meters
Summary
| Public methods |
| Int |
Compares this object with the specified object for order.
|
| Boolean |
Indicates whether some other object is "equal to" this one.
|
| static Length |
Creates a Length object with the specified value in meters.
|
| Double |
Returns length in meters
|
| Int |
Returns a hash code value for the object.
|
| String |
|
Public methods
compareTo
fun compareTo(other: Length): Int
Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
| Parameters |
o |
the object to be compared. |
other |
Length: the object to be compared. This value cannot be null. |
| Return |
Int |
a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. |
| Exceptions |
java.lang.NullPointerException |
if the specified object is null |
java.lang.ClassCastException |
if the specified object's type prevents it from being compared to this object. |
equals
fun equals(other: Any?): Boolean
Indicates whether some other object is "equal to" this one.
| Parameters |
obj |
the reference object with which to compare. |
object |
the reference object with which to compare. |
| Return |
Boolean |
true if this object is the same as the object argument; false otherwise. |
fromMeters
static fun fromMeters(value: Double): Length
Creates a Length object with the specified value in meters.
| Parameters |
value |
Double: value to be set as meters. |
| Return |
Length |
This value cannot be null. |
getInMeters
fun getInMeters(): Double
Returns length in meters
hashCode
fun hashCode(): Int
Returns a hash code value for the object.
| Return |
Int |
a hash code value for this object. |
toString
fun toString(): String
| Return |
String |
a string representation of the object. |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[null,null,["Last updated 2025-02-10 UTC."],[],[],null,["# Length\n\nAdded in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)\n\nLength\n======\n\n*** ** * ** ***\n\nKotlin \\|[Java](/reference/android/health/connect/datatypes/units/Length \"View this page in Java\") \n\n```\nclass Length : Comparable\u003cLength!\u003e\n```\n\n|---|----------------------------------------------------|\n| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) ||\n| ↳ | [android.health.connect.datatypes.units.Length](#) |\n\nRepresents a unit of length. Supported units: meters\n\nSummary\n-------\n\n| Public methods ||\n|------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [compareTo](#compareTo(android.health.connect.datatypes.units.Length))`(`other:` `[Length](#)`)` Compares this object with the specified object for order. |\n| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [equals](#equals(kotlin.Any))`(`other:` `[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?`)` Indicates whether some other object is \"equal to\" this one. |\n| static [Length](#) | [fromMeters](#fromMeters(kotlin.Double))`(`value:` `[Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)`)` Creates a Length object with the specified value in meters. |\n| [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) | [getInMeters](#getInMeters())`()` Returns length in meters |\n| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [hashCode](#hashCode())`()` Returns a hash code value for the object. |\n| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | [toString](#toString())`()` \u003cbr /\u003e |\n\nPublic methods\n--------------\n\n### compareTo\n\nAdded in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nfun compareTo(other: Length): Int\n```\n\nCompares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.\n\n| Parameters ||\n|---------|----------------------------------------------------------------------|\n| `o` | the object to be compared. |\n| `other` | [Length](#): the object to be compared. This value cannot be `null`. |\n\n| Return ||\n|----------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------|\n| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. |\n\n| Exceptions ||\n|----------------------------------|--------------------------------------------------------------------------------|\n| `java.lang.NullPointerException` | if the specified object is null |\n| `java.lang.ClassCastException` | if the specified object's type prevents it from being compared to this object. |\n\n### equals\n\nAdded in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nfun equals(other: Any?): Boolean\n```\n\nIndicates whether some other object is \"equal to\" this one.\n\n| Parameters ||\n|----------|---------------------------------------------|\n| `obj` | the reference object with which to compare. |\n| `object` | the reference object with which to compare. |\n\n| Return ||\n|------------------------------------------------------------------------------------|------------------------------------------------------------------------------|\n| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | `true` if this object is the same as the object argument; `false` otherwise. |\n\n### fromMeters\n\nAdded in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nstatic fun fromMeters(value: Double): Length\n```\n\nCreates a Length object with the specified value in meters.\n\n| Parameters ||\n|---------|--------------------------------------------------------------------------------------------------------------|\n| `value` | [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html): value to be set as meters. |\n\n| Return ||\n|-------------|------------------------------|\n| [Length](#) | This value cannot be `null`. |\n\n### getInMeters\n\nAdded in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nfun getInMeters(): Double\n```\n\nReturns length in meters \n\n### hashCode\n\nAdded in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nfun hashCode(): Int\n```\n\nReturns a hash code value for the object.\n\n| Return ||\n|----------------------------------------------------------------------------|------------------------------------|\n| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | a hash code value for this object. |\n\n### toString\n\nAdded in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nfun toString(): String\n```\n\n| Return ||\n|----------------------------------------------------------------------------------|----------------------------------------|\n| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | a string representation of the object. |"]]
