java/com/android/dialer/multimedia/MultimediaData.java

/*
 * Copyright (C) 2016 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.multimedia;

import android.location.Location;
import android.net.Uri;
import android.text.TextUtils;

import androidx.annotation.NonNull;
import androidx.annotation.Nullable;

import com.android.dialer.common.LogUtil;
import com.google.auto.value.AutoValue;

/** Holds data associated with a call. */
@AutoValue
public abstract class MultimediaData {

  public static final MultimediaData EMPTY = builder().build();

  @NonNull
  public static Builder builder() {
    return new AutoValue_MultimediaData.Builder().setImportant(false);
  }

  /**
   * Returns the text part of this data.
   *
   * <p>This field is used for both the call composer session and the post call note.
   */
  @Nullable
  public abstract String getText();

  /** Returns the location part of this data. */
  @Nullable
  public abstract Location getLocation();

  /** Returns {@code true} if this object contains image data. */
  public boolean hasImageData() {
    // imageUri and content are always either both null or nonnull
    return getImageUri() != null && getImageContentType() != null;
  }

  /** Returns the image uri part of this object's image. */
  @Nullable
  public abstract Uri getImageUri();

  /** Returns the content type part of this object's image, either image/png or image/jpeg. */
  @Nullable
  public abstract String getImageContentType();

  /** Returns {@code true} if this data is marked as important. */
  public abstract boolean isImportant();

  /** Returns true if this has image, text or location data. */
  public boolean hasData() {
    return hasImageData() || !TextUtils.isEmpty(getText()) || getLocation() != null;
  }

  /** Returns the string form of this MultimediaData with no PII. */
  @Override
  public String toString() {
    return String.format(
        "MultimediaData{subject: %s, location: %s, imageUrl: %s, imageContentType: %s, "
            + "important: %b}",
        LogUtil.sanitizePii(getText()),
        LogUtil.sanitizePii(getLocation()),
        LogUtil.sanitizePii(getImageUri()),
        getImageContentType(),
        isImportant());
  }

  /** Creates instances of {@link MultimediaData}. */
  @AutoValue.Builder
  public abstract static class Builder {

    public abstract Builder setText(@NonNull String subject);

    public abstract Builder setLocation(@NonNull Location location);

    public Builder setImage(@NonNull Uri image, @NonNull String imageContentType) {
      setImageUri(image);
      setImageContentType(imageContentType);
      return this;
    }

    abstract Builder setImageUri(@NonNull Uri image);

    abstract Builder setImageContentType(@NonNull String imageContentType);

    public abstract Builder setImportant(boolean isImportant);

    public abstract MultimediaData build();
  }
}