ej.bluetooth

Class BluetoothAdapter

java.lang.Object

ej.bluetooth.BluetoothAdapter

public class BluetoothAdapter
extends java.lang.Object

The BluetoothAdapter class represents a Bluetooth adapter.

The default adapter may be retrieved by calling getDefaultAdapter().

This class provides methods to retrieve information on the adapter, such as its name and its address. It also provides methods to retrieve the list of devices known by the adapter and the list of connected devices. A Bluetooth adapter is able to scan in order to find nearby devices. It is also able to advertise in order to be found by other devices. The GATT server of the adapter may be configured by adding services.

Method Summary

Modifier and Type	Method and Description
boolean	addService(BluetoothService service) Adds the given service to this adapter.
void	cleanupDevices() Cleanups the list of devices known by this adapter.
BluetoothService	findService(BluetoothUuid serviceUuid) Returns the service with the given UUID.
BluetoothDevice[]	getConnectedDevices() Returns the list of devices to which this adapter is connected.
static BluetoothAdapter	getDefaultAdapter() Returns the default adapter of the system.
BluetoothDevice[]	getDevices() Returns the list of devices known by this adapter.
BluetoothService[]	getServices() Returns the list of services provided by this adapter.
boolean	isAdvertising() Returns whether this adapter is currently advertising.
boolean	isScanning() Returns whether this adapter is currently scanning.
boolean	startAdvertising(AdvertisementCallbacks advertisementCallbacks, ConnectionCallbacks connectionCallbacks, byte[] payload) Starts advertising.
boolean	startScanning(ScanCallbacks scanCallbacks) Starts scanning.
boolean	stopAdvertising() Stops advertising.
boolean	stopScanning() Stops scanning.

Methods inherited from class java.lang.Object

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

Method Detail

getDefaultAdapter

public static BluetoothAdapter getDefaultAdapter()

Returns the default adapter of the system.

Returns:

the default adapter.

getDevices

public BluetoothDevice[] getDevices()

Returns the list of devices known by this adapter.

This method does not start scanning and only returns devices which have been found earlier by scanning or advertising.

Returns:

the list of devices known by this adapter.

cleanupDevices

public void cleanupDevices()

Cleanups the list of devices known by this adapter.

All devices are removed from the list except the devices to which this adapter is connected.

getConnectedDevices

public BluetoothDevice[] getConnectedDevices()

Returns the list of devices to which this adapter is connected.

Returns:

the list of devices to which this adapter is connected.

getServices

public BluetoothService[] getServices()

Returns the list of services provided by this adapter.

This method basically returns the list of services added using addService().

Returns:

the list of services provided by this adapter.

See Also:

findService(BluetoothUuid)

findService

public BluetoothService findService(BluetoothUuid serviceUuid)

Returns the service with the given UUID.

This method basically returns the service with the given UUID that was added using addService().

Parameters:

serviceUuid - the UUID of the service to look for.

Returns:

the service with the given UUID, or null if it not in the services list.

See Also:

getServices()

addService

public boolean addService(BluetoothService service)

Adds the given service to this adapter.

A service may not be added twice.

Parameters:

service - the service to add.

Returns:

true if the service was added successfully, false otherwise.

Throws:

java.lang.IllegalArgumentException - if the given service has already been added to this adapter.

startScanning

public boolean startScanning(ScanCallbacks scanCallbacks)

Starts scanning.

The scanCallbacks object will receive the scan events.

Parameters:

scanCallbacks - the object which will receive the scan events.

Returns:

true if scanning was started successfully, false otherwise.

Throws:

java.lang.IllegalStateException - if this adapter is already scanning.

See Also:

ScanCallbacks.onScanResult(BluetoothAdapter, BluetoothDevice, byte[], int), ScanCallbacks.onScanCompleted(BluetoothAdapter)

stopScanning

public boolean stopScanning()

Stops scanning.

Returns:

true if scanning was stopped successfully, false otherwise.

See Also:

ScanCallbacks.onScanCompleted(BluetoothAdapter)

isScanning

public boolean isScanning()

Returns whether this adapter is currently scanning.

Returns:

true if this adapter is currently scanning, false otherwise.

startAdvertising

public boolean startAdvertising(AdvertisementCallbacks advertisementCallbacks,
                                ConnectionCallbacks connectionCallbacks,
                                byte[] payload)

Starts advertising.

The advertisementCallbacks object will receive the advertisement events and the connectionCallbacks object will receive the connection events if a remote device connects to this adapter.

Parameters:

advertisementCallbacks - the object which will receive the advertisement events.

connectionCallbacks - the object which will receive the connection events.

payload - the advertisement payload.

Returns:

true if advertising was started successfully, false otherwise.

Throws:

java.lang.IllegalStateException - if this adapter is already advertising.

See Also:

AdvertisementCallbacks.onAdvertisementCompleted(BluetoothAdapter), ConnectionCallbacks.onConnected(BluetoothDevice)

stopAdvertising

public boolean stopAdvertising()

Stops advertising.

Returns:

true if advertising was stopped successfully, false otherwise.

See Also:

AdvertisementCallbacks.onAdvertisementCompleted(BluetoothAdapter)

isAdvertising

public boolean isAdvertising()

Returns whether this adapter is currently advertising.

Returns:

true if this adapter is currently advertising, false otherwise.