From 553c8c7753eeb80fd8d7912b1ebc990cb8f393f1 Mon Sep 17 00:00:00 2001 From: Marie Janssen Date: Thu, 12 Jan 2017 16:00:30 -0800 Subject: [PATCH] Bluetooth: minor documentation fix to de-confuse It was somewhat unclear which is the preferred method of retrieving a BluetoothAdapter. Make it clear that using BluetoothManager is preferred, and remove references to the old method in BluetoothManager docs since it is only avaialable in API 18 or higher. Test: recompile, check that documentation is updated Fix: 33355430 Change-Id: Ia20b4e45dca03bc2f13c2ab477799b89c5e14f45 --- core/java/android/bluetooth/BluetoothAdapter.java | 15 ++++++++------- core/java/android/bluetooth/BluetoothManager.java | 5 +---- 2 files changed, 9 insertions(+), 11 deletions(-) diff --git a/core/java/android/bluetooth/BluetoothAdapter.java b/core/java/android/bluetooth/BluetoothAdapter.java index ff52f27447c08..838fb72ea3ad3 100644 --- a/core/java/android/bluetooth/BluetoothAdapter.java +++ b/core/java/android/bluetooth/BluetoothAdapter.java @@ -70,9 +70,10 @@ import java.util.concurrent.locks.ReentrantReadWriteLock; * devices, and start a scan for Bluetooth LE devices. * *

To get a {@link BluetoothAdapter} representing the local Bluetooth - * adapter, when running on JELLY_BEAN_MR1 and below, call the - * static {@link #getDefaultAdapter} method; when running on JELLY_BEAN_MR2 and - * higher, call {@link BluetoothManager#getAdapter}. + * adapter, call the {@link BluetoothManager#getAdapter} function on {@link BluetoothManager}. + * On JELLY_BEAN_MR1 and below you will need to use the static {@link #getDefaultAdapter} + * method instead. + *

* Fundamentally, this is your starting point for all * Bluetooth actions. Once you have the local adapter, you can get a set of * {@link BluetoothDevice} objects representing all paired devices with @@ -81,14 +82,13 @@ import java.util.concurrent.locks.ReentrantReadWriteLock; * listen for incoming connection requests with * {@link #listenUsingRfcommWithServiceRecord(String,UUID)}; or start a scan for * Bluetooth LE devices with {@link #startLeScan(LeScanCallback callback)}. - * - *

This class is thread safe. - * + *

+ *

This class is thread safe.

*

Note: * Most methods require the {@link android.Manifest.permission#BLUETOOTH} * permission and some also require the * {@link android.Manifest.permission#BLUETOOTH_ADMIN} permission. - * + *

*
*

Developer Guides

*

@@ -565,6 +565,7 @@ public final class BluetoothAdapter { *

Currently Android only supports one Bluetooth adapter, but the API * could be extended to support more. This will always return the default * adapter. + *

* @return the default local adapter, or null if Bluetooth is not supported * on this hardware platform */ diff --git a/core/java/android/bluetooth/BluetoothManager.java b/core/java/android/bluetooth/BluetoothManager.java index 29283e793ce93..4c21aae13edf0 100644 --- a/core/java/android/bluetooth/BluetoothManager.java +++ b/core/java/android/bluetooth/BluetoothManager.java @@ -32,10 +32,7 @@ import java.util.List; * Use {@link android.content.Context#getSystemService(java.lang.String)} * with {@link Context#BLUETOOTH_SERVICE} to create an {@link BluetoothManager}, * then call {@link #getAdapter} to obtain the {@link BluetoothAdapter}. - *

- * Alternately, you can just call the static helper - * {@link BluetoothAdapter#getDefaultAdapter()}. - * + *

*
*

Developer Guides

*