# Volume

Artifact: [androidx.health.connect:connect-client](https://developer.android.com/jetpack/androidx/releases/health-connect) [View Source](https://cs.android.com/search?q=file:androidx/health/connect/client/units/Volume.kt+class:androidx.health.connect.client.units.Volume) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

*** ** * ** ***


```
public final class Volume implements Comparable<@NonNull Volume>
```

<br />

*** ** * ** ***

Represents a unit of volume. Supported units:

- liters - see `https://developer.android.com/reference/androidx/health/connect/client/units/Volume#liters(kotlin.Double)`, `https://developer.android.com/reference/androidx/health/connect/client/units/package-summary#(kotlin.Double).liters()`

- milliliters - see `https://developer.android.com/reference/androidx/health/connect/client/units/Volume#milliliters(kotlin.Double)`, `https://developer.android.com/reference/androidx/health/connect/client/units/package-summary#(kotlin.Double).milliliters()`

- US fluid ounces - see `https://developer.android.com/reference/androidx/health/connect/client/units/Volume#fluidOuncesUs(kotlin.Double)`, `https://developer.android.com/reference/androidx/health/connect/client/units/package-summary#(kotlin.Double).fluidOuncesUs()`

## Summary

| ### Public methods |
|---|---|
| `int` | `https://developer.android.com/reference/androidx/health/connect/client/units/Volume#compareTo(androidx.health.connect.client.units.Volume)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/health/connect/client/units/Volume other)` |
| `boolean` | `https://developer.android.com/reference/androidx/health/connect/client/units/Volume#equals(kotlin.Any)(https://developer.android.com/reference/java/lang/Object.html other)` |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/health/connect/client/units/Volume` | `https://developer.android.com/reference/androidx/health/connect/client/units/Volume#fluidOuncesUs(kotlin.Double)(double value)` Creates `https://developer.android.com/reference/androidx/health/connect/client/units/Volume` with the specified value in US fluid ounces. |
| `final double` | `https://developer.android.com/reference/androidx/health/connect/client/units/Volume#getFluidOuncesUs()()` Returns the volume in US fluid ounces. |
| `final double` | `https://developer.android.com/reference/androidx/health/connect/client/units/Volume#getLiters()()` Returns the volume in liters. |
| `final double` | `https://developer.android.com/reference/androidx/health/connect/client/units/Volume#getMilliliters()()` Returns the volume in milliliters. |
| `int` | `https://developer.android.com/reference/androidx/health/connect/client/units/Volume#hashCode()()` |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/health/connect/client/units/Volume` | `https://developer.android.com/reference/androidx/health/connect/client/units/Volume#liters(kotlin.Double)(double value)` Creates `https://developer.android.com/reference/androidx/health/connect/client/units/Volume` with the specified value in liters. |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/health/connect/client/units/Volume` | `https://developer.android.com/reference/androidx/health/connect/client/units/Volume#milliliters(kotlin.Double)(double value)` Creates `https://developer.android.com/reference/androidx/health/connect/client/units/Volume` with the specified value in milliliters. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/health/connect/client/units/Volume#toString()()` |

## Public methods

### compareTo

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
public int compareTo(@NonNull Volume other)
```

### equals

```
public boolean equals(Object other)
```

### fluidOuncesUs

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
public static final @NonNull Volume fluidOuncesUs(double value)
```

Creates `https://developer.android.com/reference/androidx/health/connect/client/units/Volume` with the specified value in US fluid ounces.

### getFluidOuncesUs

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
public final double getFluidOuncesUs()
```

Returns the volume in US fluid ounces.

### getLiters

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
public final double getLiters()
```

Returns the volume in liters.

### getMilliliters

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
public final double getMilliliters()
```

Returns the volume in milliliters.

### hashCode

```
public int hashCode()
```

### liters

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
public static final @NonNull Volume liters(double value)
```

Creates `https://developer.android.com/reference/androidx/health/connect/client/units/Volume` with the specified value in liters.

### milliliters

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
public static final @NonNull Volume milliliters(double value)
```

Creates `https://developer.android.com/reference/androidx/health/connect/client/units/Volume` with the specified value in milliliters.

### toString

```
public @NonNull String toString()
```