Package org.robolectric.shadows

Class ShadowBluetoothDevice

java.lang.Object

org.robolectric.shadows.ShadowBluetoothDevice

@Implements(android.bluetooth.BluetoothDevice.class)
public class ShadowBluetoothDevice
extends Object

Shadow for BluetoothDevice.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ShadowBluetoothDevice.BluetoothGattConnectionInterceptor	Interceptor interface for BluetoothGatt objects.

Constructor Summary

Constructors

Constructor	Description
ShadowBluetoothDevice()

Method Summary

Modifier and Type	Method	Description
protected boolean	cancelBondProcess()
protected BluetoothGatt	connectGatt(Context context, boolean autoConnect, BluetoothGattCallback callback)
protected BluetoothGatt	connectGatt(Context context, boolean autoConnect, BluetoothGattCallback callback, int transport)
protected BluetoothGatt	connectGatt(Context context, boolean autoConnect, BluetoothGattCallback callback, int transport, int phy, Handler handler)
protected boolean	createBond()	Returns whether this device has been bonded with.
protected BluetoothSocket	createInsecureL2capChannel(int psm)
protected BluetoothSocket	createL2capChannel(int psm)
protected BluetoothSocket	createRfcommSocketToServiceRecord(UUID uuid)
protected boolean	fetchUuidsWithSdp()	Overrides behavior of BluetoothDevice.fetchUuidsWithSdp().
protected String	getAlias()
protected String	getAliasName()
protected int	getBatteryLevel()
BluetoothClass	getBluetoothClass()	Overrides behavior of BluetoothDevice.getBluetoothClass() to return pre-set result.
List<BluetoothGatt>	getBluetoothGatts()	Returns all BluetoothGatt objects created by calling connectGatt(android.content.Context, boolean, android.bluetooth.BluetoothGattCallback).
protected int	getBondState()	Overrides behavior of BluetoothDevice.getBondState() to return pre-set result.
protected int	getConnectionHandle(int transport)
int	getFetchUuidsWithSdpCount()	Returns the number of times fetchUuidsWithSdp has been called.
protected byte[]	getMetadata(int key)
protected String	getName()
Boolean	getPairingConfirmation()	Get the confirmation value previously set with a call to BluetoothDevice.setPairingConfirmation(boolean), or null if no value is set.
byte[]	getPin()	Get the PIN previously set with a call to BluetoothDevice.setPin(byte[]), or null if no PIN has been set.
protected static IBluetooth	getService()	Implements getService() in the same way the original method does, but ignores any Exceptions from invoking BluetoothAdapter.getBluetoothService().
protected int	getType()	Overrides behavior of BluetoothDevice.getType() to return pre-set result.
protected ParcelUuid[]	getUuids()	Overrides behavior of BluetoothDevice.getUuids() to return pre-set result.
protected boolean	isConnected()
protected boolean	isInSilenceMode()
static BluetoothDevice	newInstance(String address)	Deprecated.
protected boolean	removeBond()
static void	reset()
Object	setAlias(String alias)	Set the alias for bluetooth device.
protected boolean	setAliasBeforeS(String alias)	Sets the alias name of the device.
protected int	setAliasS(String alias)	Sets the alias name of the device for API >= 31.
void	setBatteryLevel(int batteryLevel)
void	setBluetoothClass(BluetoothClass bluetoothClass)	Sets the return value for BluetoothDevice.getBluetoothClass().
void	setBondState(int bondState)	Sets value of bond state for BluetoothDevice.getBondState().
void	setConnected(boolean isConnected)
void	setConnectionHandle(int transport, int connectionHandle)
void	setCreatedBond(boolean createdBond)	Sets whether this device has been bonded with.
void	setFetchUuidsWithSdpResult(boolean fetchUuidsWithSdpResult)	Sets value of the return result for BluetoothDevice.fetchUuidsWithSdp().
void	setGattConnectionInterceptor(ShadowBluetoothDevice.BluetoothGattConnectionInterceptor interceptor)	Allows tests to intercept the BluetoothDevice.connectGatt method and set state on both BluetoothDevice and BluetoothGatt objects.
protected boolean	setMetadata(int key, byte[] value)
void	setName(String name)
boolean	setPairingConfirmation(boolean confirm)
protected boolean	setPin(byte[] pin)
void	setShouldThrowSecurityExceptions(boolean shouldThrow)	Sets if a runtime exception is thrown when bluetooth methods with BLUETOOTH_CONNECT permission pre-requisites are accessed.
boolean	setSilenceMode(boolean isInSilenceMode)
void	setThrowOnGetAliasName(boolean shouldThrow)	Sets if a runtime exception is thrown when the alias name of the device is accessed.
void	setType(int type)	Sets the return value for BluetoothDevice.getType().
void	setUuids(ParcelUuid[] uuids)	Sets the return value for BluetoothDevice.getUuids().
void	simulateGattConnectionChange(int status, int newState)	Causes to be called for every GATT client.

Methods inherited from class java.lang.Object

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

Constructor Details

ShadowBluetoothDevice

public ShadowBluetoothDevice()

Method Details

newInstance

@Deprecated
public static BluetoothDevice newInstance(String address)

Deprecated.

reset

@Resetter
public static void reset()

getService

@Implementation
protected static IBluetooth getService()

Implements getService() in the same way the original method does, but ignores any Exceptions from invoking BluetoothAdapter.getBluetoothService().

setName

public void setName(String name)

setAlias

public Object setAlias(String alias)

Set the alias for bluetooth device.

Parameters:

alias - The alias name that set to bluetooth device.

Returns:

If API is larger than or equals to S, it returns [BluetoothStatusCodes] code, otherwise it returns boolean.

setAliasBeforeS

@Implementation(maxSdk=30,
                methodName="setAlias")
protected boolean setAliasBeforeS(String alias)

Sets the alias name of the device.

Alias is the locally modified name of a remote device.

Alias Name is not part of the supported SDK, and accessed via reflection.

Parameters:

alias - alias name.

setAliasS

@Implementation(minSdk=31,
                methodName="setAlias")
protected int setAliasS(String alias)

Sets the alias name of the device for API >= 31.

Alias is the locally modified name of a remote device.

Alias Name is not part of the supported SDK, and accessed via reflection.

Parameters:

alias - alias name.

setThrowOnGetAliasName

public void setThrowOnGetAliasName(boolean shouldThrow)

Sets if a runtime exception is thrown when the alias name of the device is accessed.

Intended to replicate what may happen if the unsupported SDK is changed.

Alias is the locally modified name of a remote device.

Alias Name is not part of the supported SDK, and accessed via reflection.

Parameters:

shouldThrow - if getAliasName() should throw when called.

setShouldThrowSecurityExceptions

public void setShouldThrowSecurityExceptions(boolean shouldThrow)

Sets if a runtime exception is thrown when bluetooth methods with BLUETOOTH_CONNECT permission pre-requisites are accessed.

Intended to replicate what may happen if user has not enabled nearby device permissions.

Parameters:

shouldThrow - if methods should throw SecurityExceptions without enabled permissions when called.

getName

@Implementation
protected String getName()

getAlias

@Implementation
protected String getAlias()

getAliasName

@Implementation(maxSdk=29)
protected String getAliasName()
                       throws ReflectiveOperationException

Throws:

ReflectiveOperationException

setType

public void setType(int type)

Sets the return value for BluetoothDevice.getType().

getType

@Implementation
protected int getType()

Overrides behavior of BluetoothDevice.getType() to return pre-set result.

Returns:

Value set by calling setType(int). If setType has not previously been called, will return BluetoothDevice.DEVICE_TYPE_UNKNOWN.

setUuids

public void setUuids(ParcelUuid[] uuids)

Sets the return value for BluetoothDevice.getUuids().

getUuids

@Implementation
protected ParcelUuid[] getUuids()

Overrides behavior of BluetoothDevice.getUuids() to return pre-set result.

Returns:

Value set by calling setUuids(android.os.ParcelUuid[]). If setUuids has not previously been called, will return null.

setBondState

public void setBondState(int bondState)

Sets value of bond state for BluetoothDevice.getBondState().

cancelBondProcess

@Implementation
protected boolean cancelBondProcess()

getBondState

@Implementation
protected int getBondState()

Overrides behavior of BluetoothDevice.getBondState() to return pre-set result.

Returns:

Value set by calling setBondState(int). If setBondState has not previously been called, will return BluetoothDevice.BOND_NONE to indicate the device is not bonded.

setCreatedBond

public void setCreatedBond(boolean createdBond)

Sets whether this device has been bonded with.

createBond

@Implementation
protected boolean createBond()

Returns whether this device has been bonded with.

createInsecureL2capChannel

@Implementation(minSdk=29)
protected BluetoothSocket createInsecureL2capChannel(int psm)
                                              throws IOException

Throws:

IOException

createL2capChannel

@Implementation(minSdk=29)
protected BluetoothSocket createL2capChannel(int psm)
                                      throws IOException

Throws:

IOException

removeBond

@Implementation
protected boolean removeBond()

setPin

@Implementation
protected boolean setPin(byte[] pin)

getPin

public byte[] getPin()

Get the PIN previously set with a call to BluetoothDevice.setPin(byte[]), or null if no PIN has been set.

setPairingConfirmation

@Implementation
public boolean setPairingConfirmation(boolean confirm)

getPairingConfirmation

public Boolean getPairingConfirmation()

Get the confirmation value previously set with a call to BluetoothDevice.setPairingConfirmation(boolean), or null if no value is set.

createRfcommSocketToServiceRecord

@Implementation
protected BluetoothSocket createRfcommSocketToServiceRecord(UUID uuid)
                                                     throws IOException

Throws:

IOException

setFetchUuidsWithSdpResult

public void setFetchUuidsWithSdpResult(boolean fetchUuidsWithSdpResult)

Sets value of the return result for BluetoothDevice.fetchUuidsWithSdp().

fetchUuidsWithSdp

@Implementation
protected boolean fetchUuidsWithSdp()

Overrides behavior of BluetoothDevice.fetchUuidsWithSdp(). This method updates the counter which counts the number of invocations of this method.

Returns:

Value set by calling setFetchUuidsWithSdpResult(boolean). If not previously set, will return false by default.

getFetchUuidsWithSdpCount

public int getFetchUuidsWithSdpCount()

Returns the number of times fetchUuidsWithSdp has been called.

connectGatt

@Implementation
protected BluetoothGatt connectGatt(Context context,
 boolean autoConnect,
 BluetoothGattCallback callback)

connectGatt

@Implementation(minSdk=23)
protected BluetoothGatt connectGatt(Context context,
 boolean autoConnect,
 BluetoothGattCallback callback,
 int transport)

connectGatt

@Implementation(minSdk=26)
protected BluetoothGatt connectGatt(Context context,
 boolean autoConnect,
 BluetoothGattCallback callback,
 int transport,
 int phy,
 Handler handler)

getBluetoothGatts

public List<BluetoothGatt> getBluetoothGatts()

Returns all BluetoothGatt objects created by calling connectGatt(android.content.Context, boolean, android.bluetooth.BluetoothGattCallback).

simulateGattConnectionChange

public void simulateGattConnectionChange(int status,
 int newState)

Causes to be called for every GATT client.

Parameters:

status - Status of the GATT operation

newState - The new state of the GATT profile

getBluetoothClass

@Implementation
public BluetoothClass getBluetoothClass()

Overrides behavior of BluetoothDevice.getBluetoothClass() to return pre-set result.

Returns:

Value set by calling setBluetoothClass(android.bluetooth.BluetoothClass). If setType has not previously been called, will return null.

setBluetoothClass

public void setBluetoothClass(BluetoothClass bluetoothClass)

Sets the return value for BluetoothDevice.getBluetoothClass().

setMetadata

@Implementation(minSdk=29)
protected boolean setMetadata(int key,
 byte[] value)

getMetadata

@Implementation(minSdk=29)
protected byte[] getMetadata(int key)

setBatteryLevel

public void setBatteryLevel(int batteryLevel)

getBatteryLevel

@Implementation(minSdk=27)
protected int getBatteryLevel()

setSilenceMode

@Implementation(minSdk=29)
public boolean setSilenceMode(boolean isInSilenceMode)

isConnected

@Implementation
protected boolean isConnected()

setConnected

public void setConnected(boolean isConnected)

getConnectionHandle

@Implementation(minSdk=34)
protected int getConnectionHandle(int transport)

setConnectionHandle

public void setConnectionHandle(int transport,
 int connectionHandle)

isInSilenceMode

@Implementation(minSdk=29)
protected boolean isInSilenceMode()

setGattConnectionInterceptor

public void setGattConnectionInterceptor(ShadowBluetoothDevice.BluetoothGattConnectionInterceptor interceptor)

Allows tests to intercept the BluetoothDevice.connectGatt method and set state on both BluetoothDevice and BluetoothGatt objects. This is useful for e2e testing situations where the fine-grained execution of Bluetooth connection logic is onerous.