Fix bug of ScanSettings. Add unit test. (8679ce4a) · Commits · e / os / android_packages_modules_Bluetooth

framework/java/android/bluetooth/le/ScanSettings.java

+37 −28

Original line number	Diff line number	Diff line
		@@ -21,38 +21,37 @@ import android.os.Parcel;
		import android.os.Parcelable;

		/**
		* Bluetooth LE scan settings are passed to {@link BluetoothLeScanner#startScan}
		* to define the parameters for the scan.
		* Bluetooth LE scan settings are passed to {@link BluetoothLeScanner#startScan} to define the
		* parameters for the scan.
		*/
		public final class ScanSettings implements Parcelable {
		/**
		* Perform Bluetooth LE scan in low power mode.
		* This is the default scan mode as it consumes the least power.
		* Perform Bluetooth LE scan in low power mode. This is the default scan mode as it consumes the
		* least power.
		*/
		public static final int SCAN_MODE_LOW_POWER = 0;

		/**
		* Perform Bluetooth LE scan in balanced power mode.
		* Scan results are returned at a rate that provides a good trade-off between scan
		* frequency and power consumption.
		* Perform Bluetooth LE scan in balanced power mode. Scan results are returned at a rate that
		* provides a good trade-off between scan frequency and power consumption.
		*/
		public static final int SCAN_MODE_BALANCED = 1;

		/**
		* Scan using highest duty cycle.
		* It's recommended to only use this mode when the application is running in the foreground.
		* Scan using highest duty cycle. It's recommended to only use this mode when the application is
		* running in the foreground.
		*/
		public static final int SCAN_MODE_LOW_LATENCY = 2;

		/**
		* Trigger a callback for every Bluetooth advertisement found that matches the
		* filter criteria. If no filter is active, all advertisement packets are reported.
		* Trigger a callback for every Bluetooth advertisement found that matches the filter criteria.
		* If no filter is active, all advertisement packets are reported.
		*/
		public static final int CALLBACK_TYPE_ALL_MATCHES = 1;

		/**
		* A result callback is only triggered for the first advertisement packet received that
		* matches the filter criteria.
		* A result callback is only triggered for the first advertisement packet received that matches
		* the filter criteria.
		*/
		public static final int CALLBACK_TYPE_FIRST_MATCH = 2;

		@@ -63,15 +62,17 @@ public final class ScanSettings implements Parcelable {
		public static final int CALLBACK_TYPE_MATCH_LOST = 4;

		/**
		* Request full scan results which contain the device, rssi, advertising data, scan response
		* as well as the scan timestamp.
		* Request full scan results which contain the device, rssi, advertising data, scan response as
		* well as the scan timestamp.
		*/
		public static final int SCAN_RESULT_TYPE_FULL = 0;

		/**
		* Request abbreviated scan results which contain the device, rssi and scan timestamp.
		* <p><b>Note:</b> It is possible for an application to get more scan results than
		* it asked for, if there are multiple apps using this type.
		* <p>
		* <b>Note:</b> It is possible for an application to get more scan results than it asked for, if
		* there are multiple apps using this type.
		*
		* @hide
		*/
		@SystemApi
		@@ -109,11 +110,11 @@ public final class ScanSettings implements Parcelable {
		}

		private ScanSettings(int scanMode, int callbackType, int scanResultType,
		long reportDelaySeconds) {
		long reportDelayMillis) {
		mScanMode = scanMode;
		mCallbackType = callbackType;
		mScanResultType = scanResultType;
		mReportDelayMillis = reportDelaySeconds;
		mReportDelayMillis = reportDelayMillis;
		}

		private ScanSettings(Parcel in) {
		@@ -184,15 +185,24 @@ public final class ScanSettings implements Parcelable {
		* @throws IllegalArgumentException If the {@code callbackType} is invalid.
		*/
		public Builder setCallbackType(int callbackType) {
		if (callbackType < CALLBACK_TYPE_ALL_MATCHES
		\|\| callbackType > (CALLBACK_TYPE_FIRST_MATCH \| CALLBACK_TYPE_MATCH_LOST)
		\|\| (callbackType & CALLBACK_TYPE_ALL_MATCHES) != CALLBACK_TYPE_ALL_MATCHES) {

		if (!isValidCallbackType(callbackType)) {
		throw new IllegalArgumentException("invalid callback type - " + callbackType);
		}
		mCallbackType = callbackType;
		return this;
		}

		// Returns true if the callbackType is valid.
		private boolean isValidCallbackType(int callbackType) {
		if (callbackType == CALLBACK_TYPE_ALL_MATCHES \|\|
		callbackType == CALLBACK_TYPE_FIRST_MATCH \|\|
		callbackType == CALLBACK_TYPE_MATCH_LOST) {
		return true;
		}
		return callbackType == (CALLBACK_TYPE_FIRST_MATCH \| CALLBACK_TYPE_MATCH_LOST);
		}

		/**
		* Set scan result type for Bluetooth LE scan.
		*
		@@ -215,16 +225,15 @@ public final class ScanSettings implements Parcelable {

		/**
		* Set report delay timestamp for Bluetooth LE scan.
		* @param reportDelayMillis Set to 0 to be notified of results immediately.
		* Values > 0 causes the scan results to be queued
		* up and delivered after the requested delay or when
		* the internal buffers fill up.
		* @throws IllegalArgumentException If {@code reportDelaySeconds} < 0.
		*
		* @param reportDelayMillis Set to 0 to be notified of results immediately. Values > 0
		* causes the scan results to be queued up and delivered after the requested
		* delay or when the internal buffers fill up.
		* @throws IllegalArgumentException If {@code reportDelayMillis} < 0.
		*/
		public Builder setReportDelayMillis(long reportDelayMillis) {
		if (reportDelayMillis < 0) {
		throw new IllegalArgumentException("reportDelaySeconds must be > 0");
		throw new IllegalArgumentException("reportDelayMillis must be > 0");
		}
		mReportDelayMillis = reportDelayMillis;
		return this;

framework/tests/src/android/bluetooth/le/ScanSettingsTest.java

0 → 100644

+64 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 2014 The Android Open Source Project
		*
		* Licensed under the Apache License, Version 2.0 (the "License");
		* you may not use this file except in compliance with the License.
		* You may obtain a copy of the License at
		*
		* http://www.apache.org/licenses/LICENSE-2.0
		*
		* Unless required by applicable law or agreed to in writing, software
		* distributed under the License is distributed on an "AS IS" BASIS,
		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
		* See the License for the specific language governing permissions and
		* limitations under the License.
		*/

		package android.bluetooth.le;

		import android.test.suitebuilder.annotation.SmallTest;

		import junit.framework.TestCase;

		/**
		* Test for Bluetooth LE {@link ScanSettings}.
		*/
		public class ScanSettingsTest extends TestCase {

		@SmallTest
		public void testCallbackType() {
		ScanSettings.Builder builder = new ScanSettings.Builder();
		builder.setCallbackType(ScanSettings.CALLBACK_TYPE_ALL_MATCHES);
		builder.setCallbackType(ScanSettings.CALLBACK_TYPE_FIRST_MATCH);
		builder.setCallbackType(ScanSettings.CALLBACK_TYPE_MATCH_LOST);
		builder.setCallbackType(
		ScanSettings.CALLBACK_TYPE_FIRST_MATCH \| ScanSettings.CALLBACK_TYPE_MATCH_LOST);
		try {
		builder.setCallbackType(
		ScanSettings.CALLBACK_TYPE_ALL_MATCHES \| ScanSettings.CALLBACK_TYPE_MATCH_LOST);
		fail("should have thrown IllegalArgumentException!");
		} catch (IllegalArgumentException e) {
		// nothing to do
		}

		try {
		builder.setCallbackType(
		ScanSettings.CALLBACK_TYPE_ALL_MATCHES \|
		ScanSettings.CALLBACK_TYPE_FIRST_MATCH);
		fail("should have thrown IllegalArgumentException!");
		} catch (IllegalArgumentException e) {
		// nothing to do
		}

		try {
		builder.setCallbackType(
		ScanSettings.CALLBACK_TYPE_ALL_MATCHES \|
		ScanSettings.CALLBACK_TYPE_FIRST_MATCH \|
		ScanSettings.CALLBACK_TYPE_MATCH_LOST);
		fail("should have thrown IllegalArgumentException!");
		} catch (IllegalArgumentException e) {
		// nothing to do
		}

		}
		}