Add SpamMetadata to SpamStatus

Test: Tap, metadata not currently used anywhere
PiperOrigin-RevId: 196198986
Change-Id: I1902e527b2c5ab826e31425aab6d9b81f11fd009

3 files changed, 61 insertions, 0 deletions

diff --git a/java/com/android/dialer/spam/status/SimpleSpamStatus.java b/java/com/android/dialer/spam/status/SimpleSpamStatus.java
index ec28b9dce..ff080ed1d 100644
--- a/java/com/android/dialer/spam/status/SimpleSpamStatus.java
+++ b/java/com/android/dialer/spam/status/SimpleSpamStatus.java
@@ -33,4 +33,10 @@ public abstract class SimpleSpamStatus implements SpamStatus {
   public static SimpleSpamStatus notSpam() {
     return create(false, null);
   }
+
+  /** Returns an empty {@link SpamMetadata}. */
+  @Override
+  public final SpamMetadata getSpamMetadata() {
+    return SpamMetadata.empty();
+  }
 }
diff --git a/java/com/android/dialer/spam/status/SpamMetadata.java b/java/com/android/dialer/spam/status/SpamMetadata.java
new file mode 100644
index 000000000..40feba1a7
--- /dev/null
+++ b/java/com/android/dialer/spam/status/SpamMetadata.java
@@ -0,0 +1,52 @@
+/*
+ * Copyright (C) 2018 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.dialer.spam.status;
+
+import com.google.auto.value.AutoValue;
+import com.google.common.base.Optional;
+
+/**
+ * Holds information which can be used to determine a number's spam status.
+ *
+ * @see SpamStatus
+ */
+@AutoValue
+public abstract class SpamMetadata {
+
+  /** Returns an empty spam metadata, no optional data is set. */
+  public static SpamMetadata empty() {
+    return builder().build();
+  }
+
+  public static SpamMetadata.Builder builder() {
+    return new AutoValue_SpamMetadata.Builder();
+  }
+
+  public abstract Optional<GlobalSpamListStatus> globalSpamListStatus();
+
+  public abstract Optional<UserSpamListStatus> userSpamListStatus();
+
+  /** Creates instances of SpamMetadata. */
+  @AutoValue.Builder
+  public abstract static class Builder {
+    public abstract Builder setGlobalSpamListStatus(GlobalSpamListStatus globalSpamListStatus);
+
+    public abstract Builder setUserSpamListStatus(UserSpamListStatus userSpamListStatus);
+
+    public abstract SpamMetadata build();
+  }
+}
diff --git a/java/com/android/dialer/spam/status/SpamStatus.java b/java/com/android/dialer/spam/status/SpamStatus.java
index 8186ac5cc..10e8213ab 100644
--- a/java/com/android/dialer/spam/status/SpamStatus.java
+++ b/java/com/android/dialer/spam/status/SpamStatus.java
@@ -37,4 +37,7 @@ public interface SpamStatus {
    * </ul>
    */
   Optional<Long> getTimestampMillis();
+
+  /** Returns the {@link SpamMetadata} associated with this status. */
+  SpamMetadata getSpamMetadata();
 }