tasks/app/src/main/java/com/todoroo/astrid/api/FilterListItem.java

/*
 * Copyright (c) 2012 Todoroo Inc
 *
 * See the file "LICENSE" for the full license governing this code.
 */

package com.todoroo.astrid.api;

import android.os.Parcel;
import android.os.Parcelable;

import androidx.annotation.LayoutRes;
import androidx.annotation.NonNull;

import org.tasks.R;

import java.util.Objects;

/**
 * Represents an item displayed by Astrid's FilterListActivity
 *
 * @author Tim Su <tim@todoroo.com>
 */
public abstract class FilterListItem implements Parcelable {

  public static final int NO_ORDER = -1;

  /** Title of this item displayed on the Filters page */
  public String listingTitle = null;

  public long id = 0;
  public int icon = -1;
  public int tint = 0;
  public int count = -1;
  public int principals = 0;
  public int order = NO_ORDER;

  public abstract Type getItemType();

  @Override
  public int describeContents() {
    return 0;
  }

  /** {@inheritDoc} */
  @Override
  public void writeToParcel(Parcel dest, int flags) {
    dest.writeString(listingTitle);
    dest.writeInt(icon);
    dest.writeInt(tint);
    dest.writeInt(count);
    dest.writeInt(order);
    dest.writeLong(id);
  }

  // --- parcelable helpers

  /** Utility method to read FilterListItem properties from a parcel. */
  protected void readFromParcel(Parcel source) {
    listingTitle = source.readString();
    icon = source.readInt();
    tint = source.readInt();
    count = source.readInt();
    order = source.readInt();
    id = source.readLong();
  }

  public long getId() {
    return id;
  }

  public boolean areItemsTheSame(@NonNull FilterListItem other) {
    return getClass().equals(other.getClass()) && id == other.id;
  }

  public boolean areContentsTheSame(@NonNull FilterListItem other) {
    return Objects.equals(listingTitle, other.listingTitle)
        && icon == other.icon
        && tint == other.tint
        && count == other.count
        && order == other.order
        && principals == other.principals;
  }

  @Override
  public String toString() {
    return "FilterListItem{" +
            "listingTitle='" + listingTitle + '\'' +
            ", id=" + id +
            ", icon=" + icon +
            ", tint=" + tint +
            ", count=" + count +
            ", principals=" + principals +
            ", order=" + order +
            '}';
  }

  public enum Type {
    ITEM(R.layout.filter_adapter_row),
    ACTION(R.layout.filter_adapter_action),
    SUBHEADER(R.layout.filter_adapter_subheader),
    SEPARATOR(R.layout.filter_adapter_separator);

    public final int layout;

    Type(@LayoutRes int layout) {
      this.layout = layout;
    }
  }
}