Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

am 05107ddf: am 54b65ff3: Merge "Annotate ContentProviderClient arguments." into mnc-dev

Browse Source 
* commit '05107ddf2069f3ea0d8ef01d20d6bc4d65addc7a':
  Annotate ContentProviderClient arguments.
This commit is contained in:
Jeff Sharkey
2015-06-12 17:31:46 +00:00
committed by Android Git Automerger
parent ccd6d0c14d 05107ddf20
commit 551ca4ffc4
1 changed files with 74 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

103
core/java/android/content/ContentProviderClient.java
View File

@@ -16,6 +16,8 @@
package android.content; package android.content;
import android.annotation.NonNull;
import android.annotation.Nullable;
import android.content.res.AssetFileDescriptor; import android.content.res.AssetFileDescriptor;
import android.database.Cursor; import android.database.Cursor;
import android.net.Uri; import android.net.Uri;
@@ -30,6 +32,7 @@ import android.os.RemoteException;
import android.util.Log; import android.util.Log;
import com.android.internal.annotations.GuardedBy; import com.android.internal.annotations.GuardedBy;
import com.android.internal.util.Preconditions;
import dalvik.system.CloseGuard; import dalvik.system.CloseGuard;
@@ -109,14 +112,19 @@ public class ContentProviderClient {
} }
/** See {@link ContentProvider#query ContentProvider.query} */ /** See {@link ContentProvider#query ContentProvider.query} */
public Cursor query(Uri url, String[] projection, String selection, public @Nullable Cursor query(@NonNull Uri url, @Nullable String[] projection,
String[] selectionArgs, String sortOrder) throws RemoteException { @Nullable String selection, @Nullable String[] selectionArgs,
@Nullable String sortOrder) throws RemoteException {
return query(url, projection, selection, selectionArgs, sortOrder, null); return query(url, projection, selection, selectionArgs, sortOrder, null);
} }
/** See {@link ContentProvider#query ContentProvider.query} */ /** See {@link ContentProvider#query ContentProvider.query} */
public Cursor query(Uri url, String[] projection, String selection, String[] selectionArgs, public @Nullable Cursor query(@NonNull Uri url, @Nullable String[] projection,
String sortOrder, CancellationSignal cancellationSignal) throws RemoteException { @Nullable String selection, @Nullable String[] selectionArgs,
@Nullable String sortOrder, @Nullable CancellationSignal cancellationSignal)
throws RemoteException {
Preconditions.checkNotNull(url, "url");
beforeRemote(); beforeRemote();
try { try {
ICancellationSignal remoteCancellationSignal = null; ICancellationSignal remoteCancellationSignal = null;
@@ -138,7 +146,9 @@ public class ContentProviderClient {
} }
/** See {@link ContentProvider#getType ContentProvider.getType} */ /** See {@link ContentProvider#getType ContentProvider.getType} */
public String getType(Uri url) throws RemoteException { public @Nullable String getType(@NonNull Uri url) throws RemoteException {
Preconditions.checkNotNull(url, "url");
beforeRemote(); beforeRemote();
try { try {
return mContentProvider.getType(url); return mContentProvider.getType(url);
@@ -153,7 +163,11 @@ public class ContentProviderClient {
} }
/** See {@link ContentProvider#getStreamTypes ContentProvider.getStreamTypes} */ /** See {@link ContentProvider#getStreamTypes ContentProvider.getStreamTypes} */
public String[] getStreamTypes(Uri url, String mimeTypeFilter) throws RemoteException { public @Nullable String[] getStreamTypes(@NonNull Uri url, @NonNull String mimeTypeFilter)
throws RemoteException {
Preconditions.checkNotNull(url, "url");
Preconditions.checkNotNull(mimeTypeFilter, "mimeTypeFilter");
beforeRemote(); beforeRemote();
try { try {
return mContentProvider.getStreamTypes(url, mimeTypeFilter); return mContentProvider.getStreamTypes(url, mimeTypeFilter);
@@ -168,7 +182,9 @@ public class ContentProviderClient {
} }
/** See {@link ContentProvider#canonicalize} */ /** See {@link ContentProvider#canonicalize} */
public final Uri canonicalize(Uri url) throws RemoteException { public final @Nullable Uri canonicalize(@NonNull Uri url) throws RemoteException {
Preconditions.checkNotNull(url, "url");
beforeRemote(); beforeRemote();
try { try {
return mContentProvider.canonicalize(mPackageName, url); return mContentProvider.canonicalize(mPackageName, url);
@@ -183,7 +199,9 @@ public class ContentProviderClient {
} }
/** See {@link ContentProvider#uncanonicalize} */ /** See {@link ContentProvider#uncanonicalize} */
public final Uri uncanonicalize(Uri url) throws RemoteException { public final @Nullable Uri uncanonicalize(@NonNull Uri url) throws RemoteException {
Preconditions.checkNotNull(url, "url");
beforeRemote(); beforeRemote();
try { try {
return mContentProvider.uncanonicalize(mPackageName, url); return mContentProvider.uncanonicalize(mPackageName, url);
@@ -198,7 +216,10 @@ public class ContentProviderClient {
} }
/** See {@link ContentProvider#insert ContentProvider.insert} */ /** See {@link ContentProvider#insert ContentProvider.insert} */
public Uri insert(Uri url, ContentValues initialValues) throws RemoteException { public @Nullable Uri insert(@NonNull Uri url, @Nullable ContentValues initialValues)
throws RemoteException {
Preconditions.checkNotNull(url, "url");
beforeRemote(); beforeRemote();
try { try {
return mContentProvider.insert(mPackageName, url, initialValues); return mContentProvider.insert(mPackageName, url, initialValues);
@@ -213,7 +234,11 @@ public class ContentProviderClient {
} }
/** See {@link ContentProvider#bulkInsert ContentProvider.bulkInsert} */ /** See {@link ContentProvider#bulkInsert ContentProvider.bulkInsert} */
public int bulkInsert(Uri url, ContentValues[] initialValues) throws RemoteException { public int bulkInsert(@NonNull Uri url, @NonNull ContentValues[] initialValues)
throws RemoteException {
Preconditions.checkNotNull(url, "url");
Preconditions.checkNotNull(initialValues, "initialValues");
beforeRemote(); beforeRemote();
try { try {
return mContentProvider.bulkInsert(mPackageName, url, initialValues); return mContentProvider.bulkInsert(mPackageName, url, initialValues);
@@ -228,8 +253,10 @@ public class ContentProviderClient {
} }
/** See {@link ContentProvider#delete ContentProvider.delete} */ /** See {@link ContentProvider#delete ContentProvider.delete} */
public int delete(Uri url, String selection, String[] selectionArgs) public int delete(@NonNull Uri url, @Nullable String selection,
throws RemoteException { @Nullable String[] selectionArgs) throws RemoteException {
Preconditions.checkNotNull(url, "url");
beforeRemote(); beforeRemote();
try { try {
return mContentProvider.delete(mPackageName, url, selection, selectionArgs); return mContentProvider.delete(mPackageName, url, selection, selectionArgs);
@@ -244,8 +271,10 @@ public class ContentProviderClient {
} }
/** See {@link ContentProvider#update ContentProvider.update} */ /** See {@link ContentProvider#update ContentProvider.update} */
public int update(Uri url, ContentValues values, String selection, public int update(@NonNull Uri url, @Nullable ContentValues values, @Nullable String selection,
String[] selectionArgs) throws RemoteException { @Nullable String[] selectionArgs) throws RemoteException {
Preconditions.checkNotNull(url, "url");
beforeRemote(); beforeRemote();
try { try {
return mContentProvider.update(mPackageName, url, values, selection, selectionArgs); return mContentProvider.update(mPackageName, url, values, selection, selectionArgs);
@@ -266,7 +295,7 @@ public class ContentProviderClient {
* you use the {@link ContentResolver#openFileDescriptor * you use the {@link ContentResolver#openFileDescriptor
* ContentResolver.openFileDescriptor} API instead. * ContentResolver.openFileDescriptor} API instead.
*/ */
public ParcelFileDescriptor openFile(Uri url, String mode) public @Nullable ParcelFileDescriptor openFile(@NonNull Uri url, @NonNull String mode)
throws RemoteException, FileNotFoundException { throws RemoteException, FileNotFoundException {
return openFile(url, mode, null); return openFile(url, mode, null);
} }
@@ -278,8 +307,11 @@ public class ContentProviderClient {
* you use the {@link ContentResolver#openFileDescriptor * you use the {@link ContentResolver#openFileDescriptor
* ContentResolver.openFileDescriptor} API instead. * ContentResolver.openFileDescriptor} API instead.
*/ */
public ParcelFileDescriptor openFile(Uri url, String mode, CancellationSignal signal) public @Nullable ParcelFileDescriptor openFile(@NonNull Uri url, @NonNull String mode,
throws RemoteException, FileNotFoundException { @Nullable CancellationSignal signal) throws RemoteException, FileNotFoundException {
Preconditions.checkNotNull(url, "url");
Preconditions.checkNotNull(mode, "mode");
beforeRemote(); beforeRemote();
try { try {
ICancellationSignal remoteSignal = null; ICancellationSignal remoteSignal = null;
@@ -306,7 +338,7 @@ public class ContentProviderClient {
* you use the {@link ContentResolver#openAssetFileDescriptor * you use the {@link ContentResolver#openAssetFileDescriptor
* ContentResolver.openAssetFileDescriptor} API instead. * ContentResolver.openAssetFileDescriptor} API instead.
*/ */
public AssetFileDescriptor openAssetFile(Uri url, String mode) public @Nullable AssetFileDescriptor openAssetFile(@NonNull Uri url, @NonNull String mode)
throws RemoteException, FileNotFoundException { throws RemoteException, FileNotFoundException {
return openAssetFile(url, mode, null); return openAssetFile(url, mode, null);
} }
@@ -318,8 +350,11 @@ public class ContentProviderClient {
* you use the {@link ContentResolver#openAssetFileDescriptor * you use the {@link ContentResolver#openAssetFileDescriptor
* ContentResolver.openAssetFileDescriptor} API instead. * ContentResolver.openAssetFileDescriptor} API instead.
*/ */
public AssetFileDescriptor openAssetFile(Uri url, String mode, CancellationSignal signal) public @Nullable AssetFileDescriptor openAssetFile(@NonNull Uri url, @NonNull String mode,
throws RemoteException, FileNotFoundException { @Nullable CancellationSignal signal) throws RemoteException, FileNotFoundException {
Preconditions.checkNotNull(url, "url");
Preconditions.checkNotNull(mode, "mode");
beforeRemote(); beforeRemote();
try { try {
ICancellationSignal remoteSignal = null; ICancellationSignal remoteSignal = null;
@@ -340,15 +375,19 @@ public class ContentProviderClient {
} }
/** See {@link ContentProvider#openTypedAssetFile ContentProvider.openTypedAssetFile} */ /** See {@link ContentProvider#openTypedAssetFile ContentProvider.openTypedAssetFile} */
public final AssetFileDescriptor openTypedAssetFileDescriptor(Uri uri, public final @Nullable AssetFileDescriptor openTypedAssetFileDescriptor(@NonNull Uri uri,
String mimeType, Bundle opts) throws RemoteException, FileNotFoundException { @NonNull String mimeType, @Nullable Bundle opts)
throws RemoteException, FileNotFoundException {
return openTypedAssetFileDescriptor(uri, mimeType, opts, null); return openTypedAssetFileDescriptor(uri, mimeType, opts, null);
} }
/** See {@link ContentProvider#openTypedAssetFile ContentProvider.openTypedAssetFile} */ /** See {@link ContentProvider#openTypedAssetFile ContentProvider.openTypedAssetFile} */
public final AssetFileDescriptor openTypedAssetFileDescriptor(Uri uri, public final @Nullable AssetFileDescriptor openTypedAssetFileDescriptor(@NonNull Uri uri,
String mimeType, Bundle opts, CancellationSignal signal) @NonNull String mimeType, @Nullable Bundle opts, @Nullable CancellationSignal signal)
throws RemoteException, FileNotFoundException { throws RemoteException, FileNotFoundException {
Preconditions.checkNotNull(uri, "uri");
Preconditions.checkNotNull(mimeType, "mimeType");
beforeRemote(); beforeRemote();
try { try {
ICancellationSignal remoteSignal = null; ICancellationSignal remoteSignal = null;
@@ -370,8 +409,11 @@ public class ContentProviderClient {
} }
/** See {@link ContentProvider#applyBatch ContentProvider.applyBatch} */ /** See {@link ContentProvider#applyBatch ContentProvider.applyBatch} */
public ContentProviderResult[] applyBatch(ArrayList<ContentProviderOperation> operations) public @NonNull ContentProviderResult[] applyBatch(
throws RemoteException, OperationApplicationException { @NonNull ArrayList<ContentProviderOperation> operations)
throws RemoteException, OperationApplicationException {
Preconditions.checkNotNull(operations, "operations");
beforeRemote(); beforeRemote();
try { try {
return mContentProvider.applyBatch(mPackageName, operations); return mContentProvider.applyBatch(mPackageName, operations);
@@ -386,7 +428,10 @@ public class ContentProviderClient {
} }
/** See {@link ContentProvider#call(String, String, Bundle)} */ /** See {@link ContentProvider#call(String, String, Bundle)} */
public Bundle call(String method, String arg, Bundle extras) throws RemoteException { public @Nullable Bundle call(@NonNull String method, @Nullable String arg,
@Nullable Bundle extras) throws RemoteException {
Preconditions.checkNotNull(method, "method");
beforeRemote(); beforeRemote();
try { try {
return mContentProvider.call(mPackageName, method, arg, extras); return mContentProvider.call(mPackageName, method, arg, extras);
@@ -436,7 +481,7 @@ public class ContentProviderClient {
* @return If the associated {@link ContentProvider} is local, returns it. * @return If the associated {@link ContentProvider} is local, returns it.
* Otherwise returns null. * Otherwise returns null.
*/ */
public ContentProvider getLocalContentProvider() { public @Nullable ContentProvider getLocalContentProvider() {
return ContentProvider.coerceToLocalContentProvider(mContentProvider); return ContentProvider.coerceToLocalContentProvider(mContentProvider);
} }