BleManagerState

java.lang.Object
- java.lang.Enum<BleManagerState>
- - com.idevicesinc.sweetblue.BleManagerState

All Implemented Interfaces:

State, UsesCustomNull, java.io.Serializable, java.lang.Comparable<BleManagerState>
```
public enum BleManagerState
extends java.lang.Enum<BleManagerState>
implements State
```
An enumeration of the various states that a BleManager can be in. The manager can be in multiple states simultaneously.

See Also:

ManagerStateListener, BleManager.is(BleManagerState), BleManager.getStateMask()

Nested Class Summary
- Nested classes/interfaces inherited from interface com.idevicesinc.sweetblue.utils.State
  State.ChangeEvent<T_State extends State>, State.ChangeIntent

Enum Constant Summary

Enum Constants
Enum Constant and Description
`BLE_SCAN_READY` This state dictates that all permissions (if needed) have been granted to allow BLE scanning to return results.
`BOOST_SCANNING` This is the state that `BleManager` is in when `BleManagerConfig.scanClassicBoostLength` is not `null`, or `Interval.DISABLED`.
`IDLE` This is the state that `BleManager` is in when the update loop tick interval has been lowered, due to there being no tasks in the queue for a time dictated by `BleManagerConfig.minTimeToIdle`.
`OFF` Analogous to `BluetoothAdapter.STATE_OFF`.
`ON` Analogous to `BluetoothAdapter.STATE_ON`.
`RESETTING` This is the state that `BleManager` is in after calling `BleManager.reset()`.
`SCANNING` This is the state that `BleManager` is in when scanning actually starts.
`SCANNING_PAUSED` This is the state that `BleManager` is in when scanning has been paused (but will resume).
`STARTING_SCAN` This is the state that `BleManager` is in after calling `BleManager.startScan()` or related overloads.
`TURNING_OFF` Analogous to `BluetoothAdapter.STATE_TURNING_OFF`.
`TURNING_ON` Analogous to `BluetoothAdapter.STATE_TURNING_ON`.

Field Summary

Fields
Modifier and Type Field and Description

static int FULL_MASK
Full bitwise mask made by ORing all BleManagerState instances together.

Fields
Modifier and Type	Field and Description
`static int`	`FULL_MASK` Full bitwise mask made by ORing all `BleManagerState` instances together.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`bit()`
`boolean`	`didEnter(int oldStateBits, int newStateBits)` Given an old and new state mask, for example from `DeviceStateListener.onEvent(com.idevicesinc.sweetblue.DeviceStateListener.StateEvent)` or `ManagerStateListener.onEvent(com.idevicesinc.sweetblue.ManagerStateListener.StateEvent)`, this method tells you whether the the 'this' state was appended.
`boolean`	`didExit(int oldStateBits, int newStateBits)` Reverse of `State.didEnter(int, int)`.
`int`	`getNativeCode()` Returns the analogous native code, if applicable.
`boolean`	`isNull()` Returns `true` if this state is meant to stand in for Java's built-in `null`.
`int`	`or(BitwiseEnum state)`
`boolean`	`overlaps(int mask)`
`static BleManagerState`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static BleManagerState[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.
`static BleManagerState[]`	`VALUES()`

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - OFF
```
public static final BleManagerState OFF
```
    Analogous to BluetoothAdapter.STATE_OFF.
  - TURNING_ON
```
public static final BleManagerState TURNING_ON
```
    Analogous to BluetoothAdapter.STATE_TURNING_ON.
  - ON
```
public static final BleManagerState ON
```
    Analogous to BluetoothAdapter.STATE_ON.
  - TURNING_OFF
```
public static final BleManagerState TURNING_OFF
```
    Analogous to BluetoothAdapter.STATE_TURNING_OFF.
  - IDLE
```
public static final BleManagerState IDLE
```
    This is the state that BleManager is in when the update loop tick interval has been lowered, due to there being no tasks in the queue for a time dictated by BleManagerConfig.minTimeToIdle.
  - STARTING_SCAN
```
public static final BleManagerState STARTING_SCAN
```
    This is the state that BleManager is in after calling BleManager.startScan() or related overloads. The BleManager will only be in this state for a very short period before moving to SCANNING.
    
    See Also:
    
    BleManager.startScan()
  - BOOST_SCANNING
```
public static final BleManagerState BOOST_SCANNING
```
    This is the state that BleManager is in when BleManagerConfig.scanClassicBoostLength is not null, or Interval.DISABLED. No devices will be discovered when in this state, it's simply here to make the BLE scan give more reliable results, especially when looking for many devices. If you explicitly start a Bluetooth Classic scan, the manager will not enter this state.
  - SCANNING
```
public static final BleManagerState SCANNING
```
    This is the state that BleManager is in when scanning actually starts.
  - SCANNING_PAUSED
```
public static final BleManagerState SCANNING_PAUSED
```
    This is the state that BleManager is in when scanning has been paused (but will resume). This is mainly used with any of the startPeriodicScan methods in BleManager.
  - BLE_SCAN_READY
```
public static final BleManagerState BLE_SCAN_READY
```
    This state dictates that all permissions (if needed) have been granted to allow BLE scanning to return results. See BluetoothEnabler.
  - RESETTING
```
public static final BleManagerState RESETTING
```
    This is the state that BleManager is in after calling BleManager.reset().
- Field Detail
  - FULL_MASK
```
public static final int FULL_MASK
```
    Full bitwise mask made by ORing all BleManagerState instances together.
- Method Detail
  - values
```
public static BleManagerState[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (BleManagerState c : BleManagerState.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static BleManagerState valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - VALUES
```
public static BleManagerState[] VALUES()
```
  - getNativeCode
```
public int getNativeCode()
```
    Returns the analogous native code, if applicable. For example BluetoothAdapter.STATE_OFF, BluetoothAdapter.STATE_ON, etc. RESETTING and SCANNING do not have a native code equivalent and will return 0.
  - bit
```
public int bit()
```
  - overlaps
```
public boolean overlaps(int mask)
```
  - didEnter
```
public boolean didEnter(int oldStateBits,
                        int newStateBits)
```
    Description copied from interface: State
    
    Given an old and new state mask, for example from DeviceStateListener.onEvent(com.idevicesinc.sweetblue.DeviceStateListener.StateEvent) or ManagerStateListener.onEvent(com.idevicesinc.sweetblue.ManagerStateListener.StateEvent), this method tells you whether the the 'this' state was appended.
    
    Specified by:
    
    didEnter in interface State
    
    See Also:
    
    State.didExit(int, int)
  - didExit
```
public boolean didExit(int oldStateBits,
                       int newStateBits)
```
    Description copied from interface: State
    
    Reverse of State.didEnter(int, int).
    
    Specified by:
    
    didExit in interface State
    
    See Also:
    
    State.didEnter(int, int)
  - or
```
public int or(BitwiseEnum state)
```
  - isNull
```
public boolean isNull()
```
    Description copied from interface: State
    
    Returns true if this state is meant to stand in for Java's built-in null.
    
    Specified by:
    
    isNull in interface State
    
    Specified by:
    
    isNull in interface UsesCustomNull

Enum BleManagerState

Nested Class Summary

Nested classes/interfaces inherited from interface com.idevicesinc.sweetblue.utils.State

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

OFF

TURNING_ON

ON

TURNING_OFF

IDLE

STARTING_SCAN

BOOST_SCANNING

SCANNING

SCANNING_PAUSED

BLE_SCAN_READY

RESETTING

Field Detail

FULL_MASK

Method Detail

values

valueOf

VALUES

getNativeCode

bit

overlaps

didEnter

didExit

or

isNull