Add HeadsetPiece.java
Test: unit test.
Bug: 200231384
Change-Id: I062cd00f7589ccf2195da01b796819a7f23ea283
diff --git a/nearby/service/Android.bp b/nearby/service/Android.bp
index b33d593..14a96d1 100644
--- a/nearby/service/Android.bp
+++ b/nearby/service/Android.bp
@@ -40,9 +40,12 @@
],
static_libs: [
"androidx.annotation_annotation",
+ "androidx.core_core",
+ "auto_value_annotations",
"guava",
],
sdk_version: "system_server_current",
+ plugins: ["auto_value_plugin"],
installable: true,
optimize: {
diff --git a/nearby/service/java/com/android/server/nearby/common/bluetooth/fastpair/HeadsetPiece.java b/nearby/service/java/com/android/server/nearby/common/bluetooth/fastpair/HeadsetPiece.java
new file mode 100644
index 0000000..f387497
--- /dev/null
+++ b/nearby/service/java/com/android/server/nearby/common/bluetooth/fastpair/HeadsetPiece.java
@@ -0,0 +1,188 @@
+/*
+ * Copyright 2021 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 com.android.server.nearby.common.bluetooth.fastpair;
+
+import android.annotation.TargetApi;
+import android.net.Uri;
+import android.os.Build.VERSION_CODES;
+import android.os.Parcel;
+import android.os.Parcelable;
+
+import androidx.annotation.Nullable;
+import androidx.core.content.FileProvider;
+
+import com.google.auto.value.AutoValue;
+
+import java.util.Arrays;
+import java.util.Objects;
+
+/**
+ * This class is subclass of real headset. It contains image url, battery value and charging
+ * status.
+ */
+// Objects.equals is only available after KitKat.
+@TargetApi(VERSION_CODES.KITKAT)
+@AutoValue
+public abstract class HeadsetPiece implements Parcelable {
+
+ /**
+ * The low level threshold.
+ */
+ public abstract int lowLevelThreshold();
+
+ /**
+ * The battery level.
+ */
+ public abstract int batteryLevel();
+
+ /**
+ * The web URL of the image.
+ */
+ public abstract String imageUrl();
+
+ /**
+ * Whether the headset is charging.
+ */
+ public abstract boolean charging();
+
+ /**
+ * The content Uri of the image if it could be downloaded from the web URL and generated through
+ * {@link FileProvider#getUriForFile} successfully, otherwise null.
+ */
+ @Nullable
+ public abstract Uri imageContentUri();
+
+ /**
+ * Returns a builder of HeadsetPiece.
+ */
+ public static HeadsetPiece.Builder builder() {
+ return new AutoValue_HeadsetPiece.Builder();
+ }
+
+ HeadsetPiece() {
+ }
+
+ /**
+ * @return whether battery is low or not.
+ */
+ public boolean isBatteryLow() {
+ return batteryLevel() <= lowLevelThreshold() && batteryLevel() >= 0 && !charging();
+ }
+
+ /**
+ * Builder function for headset piece.
+ */
+ @AutoValue.Builder
+ public abstract static class Builder {
+
+ /**
+ * Set low level threshold.
+ */
+ public abstract HeadsetPiece.Builder setLowLevelThreshold(int lowLevelThreshold);
+
+ /**
+ * Set battery level.
+ */
+ public abstract HeadsetPiece.Builder setBatteryLevel(int level);
+
+ /**
+ * Set image url.
+ */
+ public abstract HeadsetPiece.Builder setImageUrl(String url);
+
+ /**
+ * Set charging.
+ */
+ public abstract HeadsetPiece.Builder setCharging(boolean charging);
+
+ /**
+ * Set image content Uri.
+ */
+ public abstract HeadsetPiece.Builder setImageContentUri(Uri uri);
+
+ /**
+ * Builds HeadSetPiece.
+ */
+ public abstract HeadsetPiece build();
+ }
+
+ @Override
+ public final void writeToParcel(Parcel dest, int flags) {
+ dest.writeString(imageUrl());
+ dest.writeInt(lowLevelThreshold());
+ dest.writeInt(batteryLevel());
+ // Writes 1 if charging, otherwise 0.
+ dest.writeByte((byte) (charging() ? 1 : 0));
+ dest.writeParcelable(imageContentUri(), flags);
+ }
+
+ @Override
+ public final int describeContents() {
+ return 0;
+ }
+
+ public static final Creator<HeadsetPiece> CREATOR =
+ new Creator<HeadsetPiece>() {
+ @Override
+ public HeadsetPiece createFromParcel(Parcel in) {
+ String imageUrl = in.readString();
+ return HeadsetPiece.builder()
+ .setImageUrl(imageUrl != null ? imageUrl : "")
+ .setLowLevelThreshold(in.readInt())
+ .setBatteryLevel(in.readInt())
+ .setCharging(in.readByte() != 0)
+ .setImageContentUri(in.readParcelable(Uri.class.getClassLoader()))
+ .build();
+ }
+
+ @Override
+ public HeadsetPiece[] newArray(int size) {
+ return new HeadsetPiece[size];
+ }
+ };
+
+ @Override
+ public final int hashCode() {
+ return Arrays.hashCode(
+ new Object[]{
+ lowLevelThreshold(), batteryLevel(), imageUrl(), charging(),
+ imageContentUri()
+ });
+ }
+
+ @Override
+ public final boolean equals(@Nullable Object other) {
+ if (other == null) {
+ return false;
+ }
+
+ if (this == other) {
+ return true;
+ }
+
+ if (!(other instanceof HeadsetPiece)) {
+ return false;
+ }
+
+ HeadsetPiece that = (HeadsetPiece) other;
+ return lowLevelThreshold() == that.lowLevelThreshold()
+ && batteryLevel() == that.batteryLevel()
+ && Objects.equals(imageUrl(), that.imageUrl())
+ && charging() == that.charging()
+ && Objects.equals(imageContentUri(), that.imageContentUri());
+ }
+}
diff --git a/nearby/tests/src/com/android/server/nearby/common/bluetooth/fastpair/HeadsetPieceTest.java b/nearby/tests/src/com/android/server/nearby/common/bluetooth/fastpair/HeadsetPieceTest.java
new file mode 100644
index 0000000..b930dfa
--- /dev/null
+++ b/nearby/tests/src/com/android/server/nearby/common/bluetooth/fastpair/HeadsetPieceTest.java
@@ -0,0 +1,186 @@
+/*
+ * Copyright (C) 2021 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 com.android.server.nearby.common.bluetooth.fastpair;
+
+import static com.google.common.truth.Truth.assertThat;
+
+import android.net.Uri;
+import android.os.Parcel;
+import android.platform.test.annotations.Presubmit;
+
+import androidx.test.filters.SmallTest;
+import androidx.test.runner.AndroidJUnit4;
+
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+/**
+ * Unit tests for {@link HeadsetPiece}.
+ */
+@Presubmit
+@SmallTest
+@RunWith(AndroidJUnit4.class)
+public class HeadsetPieceTest {
+
+ @Test
+ public void parcelAndUnparcel() {
+ HeadsetPiece headsetPiece = createDefaultHeadset().build();
+ Parcel expectedParcel = Parcel.obtain();
+ headsetPiece.writeToParcel(expectedParcel, 0);
+ expectedParcel.setDataPosition(0);
+
+ HeadsetPiece fromParcel = HeadsetPiece.CREATOR.createFromParcel(expectedParcel);
+
+ assertThat(fromParcel).isEqualTo(headsetPiece);
+ }
+
+ @Test
+ public void parcelAndUnparcel_nullImageContentUri() {
+ HeadsetPiece headsetPiece = createDefaultHeadset().setImageContentUri(null).build();
+ Parcel expectedParcel = Parcel.obtain();
+ headsetPiece.writeToParcel(expectedParcel, 0);
+ expectedParcel.setDataPosition(0);
+
+ HeadsetPiece fromParcel = HeadsetPiece.CREATOR.createFromParcel(expectedParcel);
+
+ assertThat(fromParcel).isEqualTo(headsetPiece);
+ }
+
+ @Test
+ public void equals() {
+ HeadsetPiece headsetPiece = createDefaultHeadset().build();
+
+ HeadsetPiece compareTo = createDefaultHeadset().build();
+
+ assertThat(headsetPiece).isEqualTo(compareTo);
+ }
+
+ @Test
+ public void equals_nullImageContentUri() {
+ HeadsetPiece headsetPiece = createDefaultHeadset().setImageContentUri(null).build();
+
+ HeadsetPiece compareTo = createDefaultHeadset().setImageContentUri(null).build();
+
+ assertThat(headsetPiece).isEqualTo(compareTo);
+ }
+
+ @Test
+ public void notEquals_differentLowLevelThreshold() {
+ HeadsetPiece headsetPiece = createDefaultHeadset().build();
+
+ HeadsetPiece compareTo = createDefaultHeadset().setLowLevelThreshold(1).build();
+
+ assertThat(headsetPiece).isNotEqualTo(compareTo);
+ }
+
+ @Test
+ public void notEquals_differentBatteryLevel() {
+ HeadsetPiece headsetPiece = createDefaultHeadset().build();
+
+ HeadsetPiece compareTo = createDefaultHeadset().setBatteryLevel(99).build();
+
+ assertThat(headsetPiece).isNotEqualTo(compareTo);
+ }
+
+ @Test
+ public void notEquals_differentImageUrl() {
+ HeadsetPiece headsetPiece = createDefaultHeadset().build();
+
+ HeadsetPiece compareTo =
+ createDefaultHeadset().setImageUrl("http://fake.image.path/different.png").build();
+
+ assertThat(headsetPiece).isNotEqualTo(compareTo);
+ }
+
+ @Test
+ public void notEquals_differentChargingState() {
+ HeadsetPiece headsetPiece = createDefaultHeadset().build();
+
+ HeadsetPiece compareTo = createDefaultHeadset().setCharging(false).build();
+
+ assertThat(headsetPiece).isNotEqualTo(compareTo);
+ }
+
+ @Test
+ public void notEquals_differentImageContentUri() {
+ HeadsetPiece headsetPiece = createDefaultHeadset().build();
+
+ HeadsetPiece compareTo =
+ createDefaultHeadset().setImageContentUri(Uri.parse("content://different.png"))
+ .build();
+
+ assertThat(headsetPiece).isNotEqualTo(compareTo);
+ }
+
+ @Test
+ public void notEquals_nullImageContentUri() {
+ HeadsetPiece headsetPiece = createDefaultHeadset().build();
+
+ HeadsetPiece compareTo = createDefaultHeadset().setImageContentUri(null).build();
+
+ assertThat(headsetPiece).isNotEqualTo(compareTo);
+ }
+
+ private static HeadsetPiece.Builder createDefaultHeadset() {
+ return HeadsetPiece.builder()
+ .setLowLevelThreshold(30)
+ .setBatteryLevel(18)
+ .setImageUrl("http://fake.image.path/image.png")
+ .setImageContentUri(Uri.parse("content://image.png"))
+ .setCharging(true);
+ }
+
+ @Test
+ public void isLowBattery() {
+ HeadsetPiece headsetPiece =
+ HeadsetPiece.builder()
+ .setLowLevelThreshold(30)
+ .setBatteryLevel(18)
+ .setImageUrl("http://fake.image.path/image.png")
+ .setCharging(false)
+ .build();
+
+ assertThat(headsetPiece.isBatteryLow()).isTrue();
+ }
+
+ @Test
+ public void isNotLowBattery() {
+ HeadsetPiece headsetPiece =
+ HeadsetPiece.builder()
+ .setLowLevelThreshold(30)
+ .setBatteryLevel(31)
+ .setImageUrl("http://fake.image.path/image.png")
+ .setCharging(false)
+ .build();
+
+ assertThat(headsetPiece.isBatteryLow()).isFalse();
+ }
+
+ @Test
+ public void isNotLowBattery_whileCharging() {
+ HeadsetPiece headsetPiece =
+ HeadsetPiece.builder()
+ .setLowLevelThreshold(30)
+ .setBatteryLevel(18)
+ .setImageUrl("http://fake.image.path/image.png")
+ .setCharging(true)
+ .build();
+
+ assertThat(headsetPiece.isBatteryLow()).isFalse();
+ }
+}
+