summaryrefslogtreecommitdiff
path: root/java/com/android/contacts/common/database/NoNullCursorAsyncQueryHandler.java
blob: 5d10720b5ced523a494ff6ea7952e7fdfa46b05c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
/*
 * Copyright (C) 2012 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.contacts.common.database;

import android.content.AsyncQueryHandler;
import android.content.ContentResolver;
import android.database.Cursor;
import android.net.Uri;
import android.support.annotation.Nullable;
import android.support.annotation.VisibleForTesting;
import java.util.concurrent.atomic.AtomicInteger;

/**
 * An {@AsyncQueryHandler} that will never return a null cursor.
 *
 * <p>Instead, will return a {@link Cursor} with 0 records.
 */
public abstract class NoNullCursorAsyncQueryHandler extends AsyncQueryHandler {
  private static final AtomicInteger pendingQueryCount = new AtomicInteger();
  @Nullable private static PendingQueryCountChangedListener pendingQueryCountChangedListener;

  public NoNullCursorAsyncQueryHandler(ContentResolver cr) {
    super(cr);
  }

  @Override
  public void startQuery(
      int token,
      Object cookie,
      Uri uri,
      String[] projection,
      String selection,
      String[] selectionArgs,
      String orderBy) {
    pendingQueryCount.getAndIncrement();
    if (pendingQueryCountChangedListener != null) {
      pendingQueryCountChangedListener.onPendingQueryCountChanged();
    }

    final CookieWithProjection projectionCookie = new CookieWithProjection(cookie, projection);
    super.startQuery(token, projectionCookie, uri, projection, selection, selectionArgs, orderBy);
  }

  @Override
  protected final void onQueryComplete(int token, Object cookie, Cursor cursor) {
    CookieWithProjection projectionCookie = (CookieWithProjection) cookie;

    super.onQueryComplete(token, projectionCookie.originalCookie, cursor);

    if (cursor == null) {
      cursor = new EmptyCursor(projectionCookie.projection);
    }
    onNotNullableQueryComplete(token, projectionCookie.originalCookie, cursor);

    pendingQueryCount.getAndDecrement();
    if (pendingQueryCountChangedListener != null) {
      pendingQueryCountChangedListener.onPendingQueryCountChanged();
    }
  }

  protected abstract void onNotNullableQueryComplete(int token, Object cookie, Cursor cursor);

  @VisibleForTesting(otherwise = VisibleForTesting.NONE)
  public static void setPendingQueryCountChangedListener(
      @Nullable PendingQueryCountChangedListener listener) {
    pendingQueryCountChangedListener = listener;
  }

  @VisibleForTesting(otherwise = VisibleForTesting.NONE)
  public static int getPendingQueryCount() {
    return pendingQueryCount.get();
  }

  /** Callback to listen for changes in the number of queries that have not completed. */
  public interface PendingQueryCountChangedListener {
    void onPendingQueryCountChanged();
  }

  /** Class to add projection to an existing cookie. */
  private static class CookieWithProjection {

    public final Object originalCookie;
    public final String[] projection;

    public CookieWithProjection(Object cookie, String[] projection) {
      this.originalCookie = cookie;
      this.projection = projection;
    }
  }
}