com.idevicesinc.sweetblue

Enum BondListener.Status

java.lang.Object

java.lang.Enum<BondListener.Status>

com.idevicesinc.sweetblue.BondListener.Status

All Implemented Interfaces:

UsesCustomNull, java.io.Serializable, java.lang.Comparable<BondListener.Status>

Enclosing interface:

BondListener

public static enum BondListener.Status
extends java.lang.Enum<BondListener.Status>
implements UsesCustomNull

Used on BondListener.BondEvent.status() to roughly enumerate success or failure.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALREADY_BONDING_OR_BONDED Already BleDeviceState.BONDED or in the process of BleDeviceState.BONDING.
CANCELLED_FROM_BLE_TURNING_OFF Cancelled from BleManager going BleManagerState.TURNING_OFF or BleManagerState.OFF, probably from calling BleManager.reset().
CANCELLED_FROM_UNBOND A call was made to BleDevice.unbond() at some point during the bonding process.
FAILED_EVENTUALLY We received a BluetoothDevice.ACTION_BOND_STATE_CHANGED through our internal BroadcastReceiver that we went from BleDeviceState.BONDING back to BleDeviceState.UNBONDED, which means the attempt failed.
FAILED_IMMEDIATELY The call to BluetoothDevice.createBond() returned false and thus failed immediately.
NULL Fulfills soft contract of UsesCustomNull.
NULL_DEVICE BleDevice.bond(BondListener) (or overloads) was called on BleDevice.NULL.
SUCCESS The BleDevice.bond() call succeeded.
TIMED_OUT The bond operation took longer than the time set in BleNodeConfig.taskTimeoutRequestFilter so we cut it loose.

Method Summary

Modifier and Type	Method and Description
boolean	isNull() Returns true if the object's state represents what would otherwise be Java's built-in null.
static BondListener.Status	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static BondListener.Status[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
boolean	wasCancelled()

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

NULL

public static final BondListener.Status NULL

Fulfills soft contract of UsesCustomNull.

See Also:

isNull().

SUCCESS

public static final BondListener.Status SUCCESS

The BleDevice.bond() call succeeded.

NULL_DEVICE

public static final BondListener.Status NULL_DEVICE

BleDevice.bond(BondListener) (or overloads) was called on BleDevice.NULL.

ALREADY_BONDING_OR_BONDED

public static final BondListener.Status ALREADY_BONDING_OR_BONDED

Already BleDeviceState.BONDED or in the process of BleDeviceState.BONDING.

FAILED_IMMEDIATELY

public static final BondListener.Status FAILED_IMMEDIATELY

The call to BluetoothDevice.createBond() returned false and thus failed immediately.

FAILED_EVENTUALLY

public static final BondListener.Status FAILED_EVENTUALLY

We received a BluetoothDevice.ACTION_BOND_STATE_CHANGED through our internal BroadcastReceiver that we went from BleDeviceState.BONDING back to BleDeviceState.UNBONDED, which means the attempt failed. See BondListener.BondEvent.failReason() for more information.

TIMED_OUT

public static final BondListener.Status TIMED_OUT

The bond operation took longer than the time set in BleNodeConfig.taskTimeoutRequestFilter so we cut it loose.

CANCELLED_FROM_UNBOND

public static final BondListener.Status CANCELLED_FROM_UNBOND

A call was made to BleDevice.unbond() at some point during the bonding process.

CANCELLED_FROM_BLE_TURNING_OFF

public static final BondListener.Status CANCELLED_FROM_BLE_TURNING_OFF

Cancelled from BleManager going BleManagerState.TURNING_OFF or BleManagerState.OFF, probably from calling BleManager.reset().

Method Detail

values

public static BondListener.Status[] 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 (BondListener.Status c : BondListener.Status.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BondListener.Status 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

wasCancelled

public final boolean wasCancelled()

Returns:

true for CANCELLED_FROM_BLE_TURNING_OFF or CANCELLED_FROM_UNBOND.

isNull

public final boolean isNull()

Description copied from interface: UsesCustomNull

Returns true if the object's state represents what would otherwise be Java's built-in null.

Specified by:

isNull in interface UsesCustomNull

Returns:

true if this == NULL.