The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2006 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 android.database; |
| 18 | |
Mathew Inwood | 41b3194 | 2018-08-10 16:00:53 +0100 | [diff] [blame] | 19 | import android.annotation.UnsupportedAppUsage; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 20 | import android.content.ContentResolver; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 21 | import android.net.Uri; |
| 22 | import android.os.Bundle; |
| 23 | |
Sudheer Shanka | a07b052 | 2019-01-26 10:40:42 -0800 | [diff] [blame^] | 24 | import java.util.List; |
| 25 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 26 | /** |
Andrew Stadler | 46baf53 | 2010-06-21 10:23:46 -0700 | [diff] [blame] | 27 | * Wrapper class for Cursor that delegates all calls to the actual cursor object. The primary |
| 28 | * use for this class is to extend a cursor while overriding only a subset of its methods. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 29 | */ |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 30 | public class CursorWrapper implements Cursor { |
Jeff Brown | 825c513 | 2011-10-12 16:11:30 -0700 | [diff] [blame] | 31 | /** @hide */ |
Mathew Inwood | 41b3194 | 2018-08-10 16:00:53 +0100 | [diff] [blame] | 32 | @UnsupportedAppUsage |
Jeff Brown | 825c513 | 2011-10-12 16:11:30 -0700 | [diff] [blame] | 33 | protected final Cursor mCursor; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 34 | |
Jeff Brown | 825c513 | 2011-10-12 16:11:30 -0700 | [diff] [blame] | 35 | /** |
| 36 | * Creates a cursor wrapper. |
| 37 | * @param cursor The underlying cursor to wrap. |
| 38 | */ |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 39 | public CursorWrapper(Cursor cursor) { |
| 40 | mCursor = cursor; |
| 41 | } |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 42 | |
Andrew Stadler | 46baf53 | 2010-06-21 10:23:46 -0700 | [diff] [blame] | 43 | /** |
Jeff Brown | 7ce7452 | 2011-10-07 13:29:37 -0700 | [diff] [blame] | 44 | * Gets the underlying cursor that is wrapped by this instance. |
| 45 | * |
| 46 | * @return The wrapped cursor. |
Andrew Stadler | 46baf53 | 2010-06-21 10:23:46 -0700 | [diff] [blame] | 47 | */ |
| 48 | public Cursor getWrappedCursor() { |
| 49 | return mCursor; |
| 50 | } |
| 51 | |
Jeff Brown | 4e0951e | 2015-04-09 18:28:24 -0700 | [diff] [blame] | 52 | @Override |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 53 | public void close() { |
| 54 | mCursor.close(); |
| 55 | } |
| 56 | |
Jeff Brown | 4e0951e | 2015-04-09 18:28:24 -0700 | [diff] [blame] | 57 | @Override |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 58 | public boolean isClosed() { |
| 59 | return mCursor.isClosed(); |
| 60 | } |
| 61 | |
Jeff Brown | 4e0951e | 2015-04-09 18:28:24 -0700 | [diff] [blame] | 62 | @Override |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 63 | public int getCount() { |
| 64 | return mCursor.getCount(); |
| 65 | } |
| 66 | |
Jeff Brown | 4e0951e | 2015-04-09 18:28:24 -0700 | [diff] [blame] | 67 | @Override |
| 68 | @Deprecated |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 69 | public void deactivate() { |
| 70 | mCursor.deactivate(); |
| 71 | } |
| 72 | |
Jeff Brown | 4e0951e | 2015-04-09 18:28:24 -0700 | [diff] [blame] | 73 | @Override |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 74 | public boolean moveToFirst() { |
| 75 | return mCursor.moveToFirst(); |
| 76 | } |
| 77 | |
Jeff Brown | 4e0951e | 2015-04-09 18:28:24 -0700 | [diff] [blame] | 78 | @Override |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 79 | public int getColumnCount() { |
| 80 | return mCursor.getColumnCount(); |
| 81 | } |
| 82 | |
Jeff Brown | 4e0951e | 2015-04-09 18:28:24 -0700 | [diff] [blame] | 83 | @Override |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 84 | public int getColumnIndex(String columnName) { |
| 85 | return mCursor.getColumnIndex(columnName); |
| 86 | } |
| 87 | |
Jeff Brown | 4e0951e | 2015-04-09 18:28:24 -0700 | [diff] [blame] | 88 | @Override |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 89 | public int getColumnIndexOrThrow(String columnName) |
| 90 | throws IllegalArgumentException { |
| 91 | return mCursor.getColumnIndexOrThrow(columnName); |
| 92 | } |
| 93 | |
Jeff Brown | 4e0951e | 2015-04-09 18:28:24 -0700 | [diff] [blame] | 94 | @Override |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 95 | public String getColumnName(int columnIndex) { |
| 96 | return mCursor.getColumnName(columnIndex); |
| 97 | } |
| 98 | |
Jeff Brown | 4e0951e | 2015-04-09 18:28:24 -0700 | [diff] [blame] | 99 | @Override |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 100 | public String[] getColumnNames() { |
| 101 | return mCursor.getColumnNames(); |
| 102 | } |
| 103 | |
Jeff Brown | 4e0951e | 2015-04-09 18:28:24 -0700 | [diff] [blame] | 104 | @Override |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 105 | public double getDouble(int columnIndex) { |
| 106 | return mCursor.getDouble(columnIndex); |
| 107 | } |
| 108 | |
Jeff Brown | 4e0951e | 2015-04-09 18:28:24 -0700 | [diff] [blame] | 109 | @Override |
| 110 | public void setExtras(Bundle extras) { |
| 111 | mCursor.setExtras(extras); |
| 112 | } |
| 113 | |
| 114 | @Override |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 115 | public Bundle getExtras() { |
| 116 | return mCursor.getExtras(); |
| 117 | } |
| 118 | |
Jeff Brown | 4e0951e | 2015-04-09 18:28:24 -0700 | [diff] [blame] | 119 | @Override |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 120 | public float getFloat(int columnIndex) { |
| 121 | return mCursor.getFloat(columnIndex); |
| 122 | } |
| 123 | |
Jeff Brown | 4e0951e | 2015-04-09 18:28:24 -0700 | [diff] [blame] | 124 | @Override |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 125 | public int getInt(int columnIndex) { |
| 126 | return mCursor.getInt(columnIndex); |
| 127 | } |
| 128 | |
Jeff Brown | 4e0951e | 2015-04-09 18:28:24 -0700 | [diff] [blame] | 129 | @Override |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 130 | public long getLong(int columnIndex) { |
| 131 | return mCursor.getLong(columnIndex); |
| 132 | } |
| 133 | |
Jeff Brown | 4e0951e | 2015-04-09 18:28:24 -0700 | [diff] [blame] | 134 | @Override |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 135 | public short getShort(int columnIndex) { |
| 136 | return mCursor.getShort(columnIndex); |
| 137 | } |
| 138 | |
Jeff Brown | 4e0951e | 2015-04-09 18:28:24 -0700 | [diff] [blame] | 139 | @Override |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 140 | public String getString(int columnIndex) { |
| 141 | return mCursor.getString(columnIndex); |
| 142 | } |
| 143 | |
Jeff Brown | 4e0951e | 2015-04-09 18:28:24 -0700 | [diff] [blame] | 144 | @Override |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 145 | public void copyStringToBuffer(int columnIndex, CharArrayBuffer buffer) { |
| 146 | mCursor.copyStringToBuffer(columnIndex, buffer); |
| 147 | } |
| 148 | |
Jeff Brown | 4e0951e | 2015-04-09 18:28:24 -0700 | [diff] [blame] | 149 | @Override |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 150 | public byte[] getBlob(int columnIndex) { |
| 151 | return mCursor.getBlob(columnIndex); |
| 152 | } |
| 153 | |
Jeff Brown | 4e0951e | 2015-04-09 18:28:24 -0700 | [diff] [blame] | 154 | @Override |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 155 | public boolean getWantsAllOnMoveCalls() { |
| 156 | return mCursor.getWantsAllOnMoveCalls(); |
| 157 | } |
| 158 | |
Jeff Brown | 4e0951e | 2015-04-09 18:28:24 -0700 | [diff] [blame] | 159 | @Override |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 160 | public boolean isAfterLast() { |
| 161 | return mCursor.isAfterLast(); |
| 162 | } |
| 163 | |
Jeff Brown | 4e0951e | 2015-04-09 18:28:24 -0700 | [diff] [blame] | 164 | @Override |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 165 | public boolean isBeforeFirst() { |
| 166 | return mCursor.isBeforeFirst(); |
| 167 | } |
| 168 | |
Jeff Brown | 4e0951e | 2015-04-09 18:28:24 -0700 | [diff] [blame] | 169 | @Override |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 170 | public boolean isFirst() { |
| 171 | return mCursor.isFirst(); |
| 172 | } |
| 173 | |
Jeff Brown | 4e0951e | 2015-04-09 18:28:24 -0700 | [diff] [blame] | 174 | @Override |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 175 | public boolean isLast() { |
| 176 | return mCursor.isLast(); |
| 177 | } |
| 178 | |
Jeff Brown | 4e0951e | 2015-04-09 18:28:24 -0700 | [diff] [blame] | 179 | @Override |
Vasu Nori | 8b0dd7d | 2010-05-18 11:54:31 -0700 | [diff] [blame] | 180 | public int getType(int columnIndex) { |
| 181 | return mCursor.getType(columnIndex); |
| 182 | } |
| 183 | |
Jeff Brown | 4e0951e | 2015-04-09 18:28:24 -0700 | [diff] [blame] | 184 | @Override |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 185 | public boolean isNull(int columnIndex) { |
| 186 | return mCursor.isNull(columnIndex); |
| 187 | } |
| 188 | |
Jeff Brown | 4e0951e | 2015-04-09 18:28:24 -0700 | [diff] [blame] | 189 | @Override |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 190 | public boolean moveToLast() { |
| 191 | return mCursor.moveToLast(); |
| 192 | } |
| 193 | |
Jeff Brown | 4e0951e | 2015-04-09 18:28:24 -0700 | [diff] [blame] | 194 | @Override |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 195 | public boolean move(int offset) { |
| 196 | return mCursor.move(offset); |
| 197 | } |
| 198 | |
Jeff Brown | 4e0951e | 2015-04-09 18:28:24 -0700 | [diff] [blame] | 199 | @Override |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 200 | public boolean moveToPosition(int position) { |
| 201 | return mCursor.moveToPosition(position); |
| 202 | } |
| 203 | |
Jeff Brown | 4e0951e | 2015-04-09 18:28:24 -0700 | [diff] [blame] | 204 | @Override |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 205 | public boolean moveToNext() { |
| 206 | return mCursor.moveToNext(); |
| 207 | } |
| 208 | |
Jeff Brown | 4e0951e | 2015-04-09 18:28:24 -0700 | [diff] [blame] | 209 | @Override |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 210 | public int getPosition() { |
| 211 | return mCursor.getPosition(); |
| 212 | } |
| 213 | |
Jeff Brown | 4e0951e | 2015-04-09 18:28:24 -0700 | [diff] [blame] | 214 | @Override |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 215 | public boolean moveToPrevious() { |
| 216 | return mCursor.moveToPrevious(); |
| 217 | } |
| 218 | |
Jeff Brown | 4e0951e | 2015-04-09 18:28:24 -0700 | [diff] [blame] | 219 | @Override |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 220 | public void registerContentObserver(ContentObserver observer) { |
Jeff Brown | 4e0951e | 2015-04-09 18:28:24 -0700 | [diff] [blame] | 221 | mCursor.registerContentObserver(observer); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 222 | } |
| 223 | |
Jeff Brown | 4e0951e | 2015-04-09 18:28:24 -0700 | [diff] [blame] | 224 | @Override |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 225 | public void registerDataSetObserver(DataSetObserver observer) { |
Jeff Brown | 4e0951e | 2015-04-09 18:28:24 -0700 | [diff] [blame] | 226 | mCursor.registerDataSetObserver(observer); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 227 | } |
| 228 | |
Jeff Brown | 4e0951e | 2015-04-09 18:28:24 -0700 | [diff] [blame] | 229 | @Override |
| 230 | @Deprecated |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 231 | public boolean requery() { |
| 232 | return mCursor.requery(); |
| 233 | } |
| 234 | |
Jeff Brown | 4e0951e | 2015-04-09 18:28:24 -0700 | [diff] [blame] | 235 | @Override |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 236 | public Bundle respond(Bundle extras) { |
| 237 | return mCursor.respond(extras); |
| 238 | } |
| 239 | |
Jeff Brown | 4e0951e | 2015-04-09 18:28:24 -0700 | [diff] [blame] | 240 | @Override |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 241 | public void setNotificationUri(ContentResolver cr, Uri uri) { |
Jeff Brown | 4e0951e | 2015-04-09 18:28:24 -0700 | [diff] [blame] | 242 | mCursor.setNotificationUri(cr, uri); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 243 | } |
| 244 | |
Jeff Brown | 4e0951e | 2015-04-09 18:28:24 -0700 | [diff] [blame] | 245 | @Override |
Sudheer Shanka | a07b052 | 2019-01-26 10:40:42 -0800 | [diff] [blame^] | 246 | public void setNotificationUris(ContentResolver cr, List<Uri> uris) { |
| 247 | mCursor.setNotificationUris(cr, uris); |
| 248 | } |
| 249 | |
| 250 | @Override |
Dianne Hackborn | c87c92e | 2013-05-14 13:44:29 -0700 | [diff] [blame] | 251 | public Uri getNotificationUri() { |
| 252 | return mCursor.getNotificationUri(); |
| 253 | } |
| 254 | |
Jeff Brown | 4e0951e | 2015-04-09 18:28:24 -0700 | [diff] [blame] | 255 | @Override |
Sudheer Shanka | a07b052 | 2019-01-26 10:40:42 -0800 | [diff] [blame^] | 256 | public List<Uri> getNotificationUris() { |
| 257 | return mCursor.getNotificationUris(); |
| 258 | } |
| 259 | |
| 260 | @Override |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 261 | public void unregisterContentObserver(ContentObserver observer) { |
Jeff Brown | 4e0951e | 2015-04-09 18:28:24 -0700 | [diff] [blame] | 262 | mCursor.unregisterContentObserver(observer); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 263 | } |
| 264 | |
Jeff Brown | 4e0951e | 2015-04-09 18:28:24 -0700 | [diff] [blame] | 265 | @Override |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 266 | public void unregisterDataSetObserver(DataSetObserver observer) { |
| 267 | mCursor.unregisterDataSetObserver(observer); |
| 268 | } |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 269 | } |
| 270 | |