Volume

Kotlin |Java

public final class Volume
extends Object implements Comparable<Volume>

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

Represents a unit of volume. Supported units: liters

Summary

Public methods
`int`	`compareTo(Volume 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 Volume`	`fromLiters(double value)` Creates a Volume object with the specified value in liters.
`double`	`getInLiters()` Returns volume in liters
`int`	`hashCode()` Returns a hash code value for the object.
`String`	`toString()` Returns a string representation of the object.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          java.lang.Comparable


      compareTo(Volume o)

Compares this object with the specified object for order.

Public methods

compareTo

Added in API level 34

public int compareTo (Volume 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`	`Volume`: 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.

fromLiters

Added in API level 34

public static Volume fromLiters (double value)

Creates a Volume object with the specified value in liters.

Parameters
`value`	`double`: value to be set as liters.

Returns
`Volume`	This value cannot be `null`.

getInLiters

Added in API level 34

public double getInLiters ()

Returns volume in liters

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.