1 /* 2 * Copyright (C) 2018 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License 15 */ 16 17 package com.android.dialer.spam.status; 18 19 import com.google.common.base.Optional; 20 21 /** An interface representing a number's spam status. */ 22 @SuppressWarnings("Guava") 23 public interface SpamStatus { 24 25 /** Returns true if the number is spam. */ isSpam()26 boolean isSpam(); 27 28 /** 29 * Returns the timestamp (in milliseconds) indicating when the number's spam status entered the 30 * underlying data source. 31 * 32 * <p>{@code Optional.absent()} is returned if 33 * 34 * <ul> 35 * <li>the number's spam status doesn't exist in the underlying data source, or 36 * <li>the underlying data source can't provide a timestamp. 37 * </ul> 38 */ getTimestampMillis()39 Optional<Long> getTimestampMillis(); 40 41 /** Returns the {@link SpamMetadata} associated with this status. */ getSpamMetadata()42 SpamMetadata getSpamMetadata(); 43 } 44