Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Constants](https://developer.android.com/reference/android/hardware/BatteryState#constants) \| [Ctors](https://developer.android.com/reference/android/hardware/BatteryState#pubctors) \| [Methods](https://developer.android.com/reference/android/hardware/BatteryState#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/hardware/BatteryState#inhmethods)

# BatteryState

*** ** * ** ***


`
public


abstract
class
BatteryState
`


`

extends https://developer.android.com/reference/java/lang/Object


`

`


`

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.hardware.BatteryState |

<br />

*** ** * ** ***

The BatteryState class is a representation of a single battery on a device.

## Summary

| ### Constants ||
|---|---|
| `int` | `https://developer.android.com/reference/android/hardware/BatteryState#STATUS_CHARGING` Battery is charging. |
| `int` | `https://developer.android.com/reference/android/hardware/BatteryState#STATUS_DISCHARGING` Battery is discharging. |
| `int` | `https://developer.android.com/reference/android/hardware/BatteryState#STATUS_FULL` Battery is full. |
| `int` | `https://developer.android.com/reference/android/hardware/BatteryState#STATUS_NOT_CHARGING` Battery is connected to power but not charging. |
| `int` | `https://developer.android.com/reference/android/hardware/BatteryState#STATUS_UNKNOWN` Battery status is unknown. |

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/android/hardware/BatteryState#BatteryState()() ` |

| ### Public methods ||
|---|---|
| ` abstract float` | ` https://developer.android.com/reference/android/hardware/BatteryState#getCapacity()() ` Get remaining battery capacity as float percentage \[0.0f, 1.0f\] of total capacity Returns NaN when battery capacity can't be read. |
| ` abstract int` | ` https://developer.android.com/reference/android/hardware/BatteryState#getStatus()() ` Get the battery status. |
| ` abstract boolean` | ` https://developer.android.com/reference/android/hardware/BatteryState#isPresent()() ` Check whether the hardware has a battery. |

| ### Inherited methods |
|---|---|
| From class ` https://developer.android.com/reference/java/lang/Object ` |---|---| | ` https://developer.android.com/reference/java/lang/Object` | ` https://developer.android.com/reference/java/lang/Object#clone()() ` Creates and returns a copy of this object. | | ` boolean` | ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` https://developer.android.com/reference/java/lang/Object#finalize()() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final https://developer.android.com/reference/java/lang/Class<?>` | ` https://developer.android.com/reference/java/lang/Object#getClass()() ` Returns the runtime class of this `Object`. | | ` int` | ` https://developer.android.com/reference/java/lang/Object#hashCode()() ` Returns a hash code value for the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notify()() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notifyAll()() ` Wakes up all threads that are waiting on this object's monitor. | | ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/Object#toString()() ` Returns a string representation of the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(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` | ` https://developer.android.com/reference/java/lang/Object#wait(long)(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` | ` https://developer.android.com/reference/java/lang/Object#wait()() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | ||

## Constants

### STATUS_CHARGING

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int STATUS_CHARGING
```

Battery is charging.

<br />

Constant Value:

2
(0x00000002)


### STATUS_DISCHARGING

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int STATUS_DISCHARGING
```

Battery is discharging.

<br />

Constant Value:

3
(0x00000003)


### STATUS_FULL

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int STATUS_FULL
```

Battery is full.

<br />

Constant Value:

5
(0x00000005)


### STATUS_NOT_CHARGING

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int STATUS_NOT_CHARGING
```

Battery is connected to power but not charging.

<br />

Constant Value:

4
(0x00000004)


### STATUS_UNKNOWN

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int STATUS_UNKNOWN
```

Battery status is unknown.

<br />

Constant Value:

1
(0x00000001)


## Public constructors

### BatteryState

```
public BatteryState ()
```

<br />

<br />

## Public methods

### getCapacity

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public abstract float getCapacity ()
```

Get remaining battery capacity as float percentage \[0.0f, 1.0f\] of total capacity
Returns NaN when battery capacity can't be read.

<br />

| Returns ||
|---|---|
| `float` | the battery capacity. Value is between -1.0f and 1.0f inclusive <br /> |

### getStatus

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public abstract int getStatus ()
```

Get the battery status.

<br />

| Returns ||
|---|---|
| `int` | the battery status. Value is one of the following: - `https://developer.android.com/reference/android/hardware/BatteryState#STATUS_UNKNOWN` - `https://developer.android.com/reference/android/hardware/BatteryState#STATUS_CHARGING` - `https://developer.android.com/reference/android/hardware/BatteryState#STATUS_DISCHARGING` - `https://developer.android.com/reference/android/hardware/BatteryState#STATUS_NOT_CHARGING` - `https://developer.android.com/reference/android/hardware/BatteryState#STATUS_FULL` |

### isPresent

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public abstract boolean isPresent ()
```

Check whether the hardware has a battery.

<br />

| Returns ||
|---|---|
| `boolean` | True if the hardware has a battery, else false. <br /> |