com.idevicesinc.sweetblue

Class UnitTestBluetoothManager

java.lang.Object

com.idevicesinc.sweetblue.UnitTestBluetoothManager

All Implemented Interfaces:

IBluetoothManager

public class UnitTestBluetoothManager
extends java.lang.Object
implements IBluetoothManager

Base class used to mock the bluetooth manager instance (at the android layer). This class is setup to always work.

Nested Class Summary

Nested classes/interfaces inherited from interface com.idevicesinc.sweetblue.internal.android.IBluetoothManager

IBluetoothManager.DefaultFactory, IBluetoothManager.Factory

Field Summary

Fields inherited from interface com.idevicesinc.sweetblue.internal.android.IBluetoothManager

DEFAULT_FACTORY, DEFAULT_INSTANCE

Constructor Summary

Constructors

Constructor and Description
UnitTestBluetoothManager()

Method Summary

Modifier and Type	Method and Description
void	addBondedDevice(BleDevice device) Called when the system wants to track a new device as being bonded.
boolean	cancelDiscovery() Called internally when the system wants to stop a classic scan.
boolean	disable() Called by the library when attempting to turn off the Bluetooth radio.
boolean	enable() Called by the system when the library wants to turn the Bluetooth radio on.
java.lang.String	getAddress() Returns the mac address of the "controller" (the phone/tablet).
int	getBleState() Returns the same as getState()
java.util.Set<P_DeviceHolder>	getBondedDevices() Returns a Set of P_DeviceHolder representing the devices that are currently bonded to this manager/adaptor.
int	getConnectionState(IBluetoothDevice device, int profile) Returns the connection state of this device.
java.lang.String	getName() Returns the name of this manager/adaptor.
android.bluetooth.BluetoothAdapter	getNativeAdaptor() Returns null as the adaptor is mocked.
android.bluetooth.BluetoothManager	getNativeManager() Returns null as the manager is mocked.
android.bluetooth.BluetoothDevice	getRemoteDevice(java.lang.String macAddress) Default returns null.
int	getState() Returns the native state of the Bluetooth Adaptor
boolean	isBluetooth5HighSpeedSupported() Returns true if bluetooth 5 high speed is supported.
boolean	isBluetooth5LongRangeSupported() Returns true if bluetooth 5 long range is supported.
boolean	isBluetoothEnabled() Returns true if the bluetooth radio is on.
boolean	isLocationEnabledForScanning_byOsServices() Returns true if location services are supported by the OS.
boolean	isLocationEnabledForScanning_byRuntimePermissions() Returns true if location service permissions have been granted.
boolean	isLocationEnabledForScanning() Returns true if location services have been enabled.
boolean	isManagerNull() Returns true if the manager instance is "null" (this is all just mocked)
boolean	isMultipleAdvertisementSupported() Returns true if multiple advertisement is supported (using an android device to advertise to other bluetooth controllers).
protected void	manuallySetState(int newState) Allows you to manually set the native state of this manager/adaptor.
P_ServerHolder	openGattServer(android.content.Context context, IServerListener listeners) Called by the library when a BleServer is getting created.
void	removeBondedDevice(BleDevice device) Called when a device is no longer bonded.
void	resetManager(android.content.Context context) Called by the library when it needs to instantiate the bluetooth manager.
void	setIBleManager(IBleManager mgr) Called internally to set the IBleManager instance.
boolean	setName(java.lang.String name) Sets the name of the bluetooth manager/adaptor.
protected void	setToOff() Called by disable().
protected void	setToOn() Called by enable().
protected void	setToTurningOff() Called by disable().
protected void	setToTurningOn() Called by enable().
void	startAdvertising(android.bluetooth.le.AdvertiseSettings settings, android.bluetooth.le.AdvertiseData adData, L_Util.AdvertisingCallback callback) Called by the system when the library wants the manager/adaptor to advertise over bluetooth.
boolean	startDiscovery() Called by the library when it wants to start bluetooth classic discovery.
boolean	startLeScan(android.bluetooth.BluetoothAdapter.LeScanCallback callback) Called when the library wants to start a pre-lollipop scan.
void	startLScan(int scanMode, Interval delay, L_Util.ScanCallback callback) Called when the library wants to start a post-lollipop scan (Lollipop only).
void	startMScan(int scanMode, Interval delay, L_Util.ScanCallback callback) Called when the library wants to start a post-lollipop scan on marshmallow or above.
boolean	startPendingIntentScan(int scanMode, Interval delay, android.app.PendingIntent pendingIntent) Called when the library wants to start a BLE scan using a PendingIntent to deliver scan results.
void	stopAdvertising() Called by the library when it wants to stop the BleServer from advertising.
void	stopLeScan(android.bluetooth.BluetoothAdapter.LeScanCallback callback) Called when the system wants to stop an LE scan.
void	stopPendingIntentScan(android.app.PendingIntent pendingIntent) Called when the system wants to stop a PendingIntent scan.
void	updateDeviceState(IBleDevice device, int state) Called internally to update the state of a BleDevice.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UnitTestBluetoothManager

public UnitTestBluetoothManager()

Method Detail

setIBleManager

public void setIBleManager(IBleManager mgr)

Called internally to set the IBleManager instance. There should be no reason to override this method.

Specified by:

setIBleManager in interface IBluetoothManager

getConnectionState

public int getConnectionState(IBluetoothDevice device,
                              int profile)

Returns the connection state of this device. You shouldn't need to override this method.

Specified by:

getConnectionState in interface IBluetoothManager

startDiscovery

public boolean startDiscovery()

Called by the library when it wants to start bluetooth classic discovery. This does nothing in unit testing.

Specified by:

startDiscovery in interface IBluetoothManager

cancelDiscovery

public boolean cancelDiscovery()

Called internally when the system wants to stop a classic scan.

Specified by:

cancelDiscovery in interface IBluetoothManager

isManagerNull

public boolean isManagerNull()

Returns true if the manager instance is "null" (this is all just mocked)

Specified by:

isManagerNull in interface IBluetoothManager

updateDeviceState

public void updateDeviceState(IBleDevice device,
                              int state)

Called internally to update the state of a BleDevice.

disable

public boolean disable()

Called by the library when attempting to turn off the Bluetooth radio. This calls setToTurningOff() and setToOff(), which are the methods you should override to change behavior.

Specified by:

disable in interface IBluetoothManager

enable

public boolean enable()

Called by the system when the library wants to turn the Bluetooth radio on. This calls setToTurningOn() and setToOn(), which are the methods you should override to change behavior.

Specified by:

enable in interface IBluetoothManager

isMultipleAdvertisementSupported

public boolean isMultipleAdvertisementSupported()

Returns true if multiple advertisement is supported (using an android device to advertise to other bluetooth controllers). Default is true

Specified by:

isMultipleAdvertisementSupported in interface IBluetoothManager

isBluetooth5LongRangeSupported

public boolean isBluetooth5LongRangeSupported()

Returns true if bluetooth 5 long range is supported. Default is true

Specified by:

isBluetooth5LongRangeSupported in interface IBluetoothManager

isBluetooth5HighSpeedSupported

public boolean isBluetooth5HighSpeedSupported()

Returns true if bluetooth 5 high speed is supported. Default is true

Specified by:

isBluetooth5HighSpeedSupported in interface IBluetoothManager

resetManager

public void resetManager(android.content.Context context)

Called by the library when it needs to instantiate the bluetooth manager. As in unit tests this is all mocked out, this method doesn't do anything.

Specified by:

resetManager in interface IBluetoothManager

getState

public int getState()

Returns the native state of the Bluetooth Adaptor

Specified by:

getState in interface IBluetoothManager

getBleState

public int getBleState()

Returns the same as getState()

Specified by:

getBleState in interface IBluetoothManager

getName

public java.lang.String getName()

Returns the name of this manager/adaptor. This is the name shown if you want to use BleServer to advertise a device.

Specified by:

getName in interface IBluetoothManager

setName

public boolean setName(java.lang.String name)

Sets the name of the bluetooth manager/adaptor.

Specified by:

setName in interface IBluetoothManager

getAddress

public java.lang.String getAddress()

Returns the mac address of the "controller" (the phone/tablet).

Specified by:

getAddress in interface IBluetoothManager

getBondedDevices

public java.util.Set<P_DeviceHolder> getBondedDevices()

Returns a Set of P_DeviceHolder representing the devices that are currently bonded to this manager/adaptor.

Specified by:

getBondedDevices in interface IBluetoothManager

addBondedDevice

public void addBondedDevice(BleDevice device)

Called when the system wants to track a new device as being bonded.

removeBondedDevice

public void removeBondedDevice(BleDevice device)

Called when a device is no longer bonded.

getNativeAdaptor

public android.bluetooth.BluetoothAdapter getNativeAdaptor()

Returns null as the adaptor is mocked.

Specified by:

getNativeAdaptor in interface IBluetoothManager

getNativeManager

public android.bluetooth.BluetoothManager getNativeManager()

Returns null as the manager is mocked.

Specified by:

getNativeManager in interface IBluetoothManager

openGattServer

public P_ServerHolder openGattServer(android.content.Context context,
                                     IServerListener listeners)

Called by the library when a BleServer is getting created.

Specified by:

openGattServer in interface IBluetoothManager

startAdvertising

public void startAdvertising(android.bluetooth.le.AdvertiseSettings settings,
                             android.bluetooth.le.AdvertiseData adData,
                             L_Util.AdvertisingCallback callback)

Called by the system when the library wants the manager/adaptor to advertise over bluetooth.

Specified by:

startAdvertising in interface IBluetoothManager

stopAdvertising

public void stopAdvertising()

Called by the library when it wants to stop the BleServer from advertising.

Specified by:

stopAdvertising in interface IBluetoothManager

isLocationEnabledForScanning_byOsServices

public boolean isLocationEnabledForScanning_byOsServices()

Returns true if location services are supported by the OS. Default is true

Specified by:

isLocationEnabledForScanning_byOsServices in interface IBluetoothManager

isLocationEnabledForScanning_byRuntimePermissions

public boolean isLocationEnabledForScanning_byRuntimePermissions()

Returns true if location service permissions have been granted. Default is true

Specified by:

isLocationEnabledForScanning_byRuntimePermissions in interface IBluetoothManager

isLocationEnabledForScanning

public boolean isLocationEnabledForScanning()

Returns true if location services have been enabled. Default is true

Specified by:

isLocationEnabledForScanning in interface IBluetoothManager

isBluetoothEnabled

public boolean isBluetoothEnabled()

Returns true if the bluetooth radio is on.

Specified by:

isBluetoothEnabled in interface IBluetoothManager

startLScan

public void startLScan(int scanMode,
                       Interval delay,
                       L_Util.ScanCallback callback)

Called when the library wants to start a post-lollipop scan (Lollipop only). This method does nothing.

Specified by:

startLScan in interface IBluetoothManager

startMScan

public void startMScan(int scanMode,
                       Interval delay,
                       L_Util.ScanCallback callback)

Called when the library wants to start a post-lollipop scan on marshmallow or above. This method does nothing.

Specified by:

startMScan in interface IBluetoothManager

startLeScan

public boolean startLeScan(android.bluetooth.BluetoothAdapter.LeScanCallback callback)

Called when the library wants to start a pre-lollipop scan. This method does nothing other than returning true.

Specified by:

startLeScan in interface IBluetoothManager

stopLeScan

public void stopLeScan(android.bluetooth.BluetoothAdapter.LeScanCallback callback)

Called when the system wants to stop an LE scan.

Specified by:

stopLeScan in interface IBluetoothManager

stopPendingIntentScan

public void stopPendingIntentScan(android.app.PendingIntent pendingIntent)

Called when the system wants to stop a PendingIntent scan. This only applies for devices on Oreo or above.

Specified by:

stopPendingIntentScan in interface IBluetoothManager

startPendingIntentScan

public boolean startPendingIntentScan(int scanMode,
                                      Interval delay,
                                      android.app.PendingIntent pendingIntent)

Called when the library wants to start a BLE scan using a PendingIntent to deliver scan results. This method does nothing other than returning true.

Specified by:

startPendingIntentScan in interface IBluetoothManager

getRemoteDevice

public android.bluetooth.BluetoothDevice getRemoteDevice(java.lang.String macAddress)

Default returns null.

Specified by:

getRemoteDevice in interface IBluetoothManager

manuallySetState

protected void manuallySetState(int newState)

Allows you to manually set the native state of this manager/adaptor.

setToTurningOff

protected void setToTurningOff()

Called by disable(). This sets the state to TURNING_OFF.

setToOff

protected void setToOff()

Called by disable(). This sets the state to OFF.

setToTurningOn

protected void setToTurningOn()

Called by enable(). This sets the state to TURNING_ON.

setToOn

protected void setToOn()

Called by enable(). This sets the state to ON.