Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit abb65587 authored by Matthew Xie's avatar Matthew Xie
Browse files

Update javadoc to give app write better guidence 

Update javadoc of close methods of GATT cliet and server
Update javadoc of BluetoothAdapter
bug 8963528

Change-Id: I45ec618fd495225ed11a6171f33bfdc218397d4c
parent 1626eab8

framework/java/android/bluetooth/BluetoothAdapter.java

+8 −3
Original line number Diff line number Diff line
@@ -47,17 +47,22 @@ import java.util.UUID; 
 * device discovery, query a list of bonded (paired) devices,

 * instantiate a {@link BluetoothDevice} using a known MAC address, and create

 * a {@link BluetoothServerSocket} to listen for connection requests from other

 * devices.

 * devices, and start a scan for Bluetooth LE devices.

 *

 * <p>To get a {@link BluetoothAdapter} representing the local Bluetooth

 * adapter, call the static {@link #getDefaultAdapter} method.

 * adapter, when running on JELLY_BEAN_MR1 and below, call the 

 * static {@link #getDefaultAdapter} method; when running on JELLY_BEAN_MR2 and

 * higher, retrieve it through

 * {@link android.content.Context#getSystemService} with

 * {@link android.content.Context#BLUETOOTH_SERVICE}.

 * 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

 * {@link #getBondedDevices()}; start device discovery with

 * {@link #startDiscovery()}; or create a {@link BluetoothServerSocket} to

 * listen for incoming connection requests with

 * {@link #listenUsingRfcommWithServiceRecord(String,UUID)}.

 * {@link #listenUsingRfcommWithServiceRecord(String,UUID)}; or start a scan for

 * Bluetooth LE devices with {@link #startLeScan(LeScanCallback callback)}.

 *

 * <p class="note"><strong>Note:</strong>

 * Most methods require the {@link android.Manifest.permission#BLUETOOTH}

framework/java/android/bluetooth/BluetoothDevice.java

+1 −1
Original line number Diff line number Diff line
@@ -107,7 +107,7 @@ public final class BluetoothDevice implements Parcelable { 
     * <p>Always contains the extra fields {@link #EXTRA_DEVICE} and {@link

     * #EXTRA_CLASS}.

     * <p>Requires {@link android.Manifest.permission#BLUETOOTH} to receive.

     * @see {@link BluetoothClass}

     * {@see BluetoothClass}

     */

    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)

    public static final String ACTION_CLASS_CHANGED =

framework/java/android/bluetooth/BluetoothGatt.java

+3 −0
Original line number Diff line number Diff line
@@ -565,6 +565,9 @@ public final class BluetoothGatt implements BluetoothProfile { 


    /**

     * Close this Bluetooth GATT client.

     *

     * Application should call this method as early as possible after it is done with

     * this GATT client.

     */

    public void close() {

        if (DBG) Log.d(TAG, "close()");

framework/java/android/bluetooth/BluetoothGattCallback.java

+3 −0
Original line number Diff line number Diff line
@@ -27,6 +27,7 @@ public abstract class BluetoothGattCallback { 
     *

     * @param gatt GATT client

     * @param status Status of the connect or disconnect operation.

     *               {@link BluetoothGatt#GATT_SUCCESS} if the operation succeeds.

     * @param newState Returns the new connection state. Can be one of

     *                  {@link BluetoothProfile#STATE_DISCONNECTED} or

     *                  {@link BluetoothProfile#STATE_CONNECTED}
@@ -72,6 +73,7 @@ public abstract class BluetoothGattCallback { 
     * @param characteristic Characteristic that was written to the associated

     *                       remote device.

     * @param status The result of the write operation

     *               {@link BluetoothGatt#GATT_SUCCESS} if the operation succeeds.

     */

    public void onCharacteristicWrite(BluetoothGatt gatt,

                                      BluetoothGattCharacteristic characteristic, int status) {
@@ -108,6 +110,7 @@ public abstract class BluetoothGattCallback { 
     * @param descriptor Descriptor that was writte to the associated

     *                   remote device.

     * @param status The result of the write operation

     *               {@link BluetoothGatt#GATT_SUCCESS} if the operation succeeds.

     */

    public void onDescriptorWrite(BluetoothGatt gatt, BluetoothGattDescriptor descriptor,

                                  int status) {

framework/java/android/bluetooth/BluetoothGattServer.java

+3 −0
Original line number Diff line number Diff line
@@ -289,6 +289,9 @@ public final class BluetoothGattServer implements BluetoothProfile { 


    /**

     * Close this GATT server instance.

     *

     * Application should call this method as early as possible after it is done with

     * this GATT server.

     */

    public void close() {

        if (DBG) Log.d(TAG, "close()");