Added in API level 34

Length


public final class Length
extends Object implements Comparable<Length>

java.lang.Object
   ↳ android.health.connect.datatypes.units.Length


Represents a unit of length. Supported units: meters

Summary

Public methods

int compareTo(Length other)

Compares this object with the specified object for order.

boolean equals(Object object)

Indicates whether some other object is "equal to" this one.

static Length fromMeters(double value)

Creates a Length object with the specified value in meters.

double getInMeters()

Returns length in meters

int hashCode()

Returns a hash code value for the object.

String toString()

Returns a string representation of the object.

Inherited methods

Public methods

compareTo

Added in API level 34
public int compareTo (Length other)

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
other Length: the object to be compared. This value cannot be null.

Returns
int a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Throws
NullPointerException if the specified object is null
ClassCastException if the specified object's type prevents it from being compared to this object.

equals

Added in API level 34
public boolean equals (Object object)

Indicates whether some other object is "equal to" this one.

Parameters
object Object: the reference object with which to compare.

Returns
boolean true if this object is the same as the object argument; false otherwise.

fromMeters

Added in API level 34
public static Length fromMeters (double value)

Creates a Length object with the specified value in meters.

Parameters
value double: value to be set as meters.

Returns
Length This value cannot be null.

getInMeters

Added in API level 34
public double getInMeters ()

Returns length in meters

Returns
double

hashCode

Added in API level 34
public int hashCode ()

Returns a hash code value for the object.

Returns
int a hash code value for this object.

toString

Added in API level 34
public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.