Merge pull request #50 from square/jw/vomit

Sprinkle more annotation vomit all over the public API.

Author: Alec Strong

sqlbrite/src/main/java/com/squareup/sqlbrite/BriteContentResolver.java

@@ -71,7 +71,7 @@ public void setLoggingEnabled(boolean enabled) {
    * @see ContentResolver#query(Uri, String[], String, String[], String)
    * @see ContentResolver#registerContentObserver(Uri, boolean, ContentObserver)
    */
-  @CheckResult
+  @CheckResult @NonNull
   public QueryObservable createQuery(@NonNull final Uri uri, @Nullable final String[] projection,
       @Nullable final String selection, @Nullable final String[] selectionArgs, @Nullable
       final String sortOrder, final boolean notifyForDescendents) {

sqlbrite/src/main/java/com/squareup/sqlbrite/BriteDatabase.java

@@ -187,6 +187,7 @@ private void sendTableTrigger(Set<String> tables) {
    *
    * @see SQLiteDatabase#beginTransaction()
    */
+  @CheckResult @NonNull
   public Transaction newTransaction() {
     SqliteTransaction transaction = new SqliteTransaction(transactions.get());
     transactions.set(transaction);
@@ -224,7 +225,7 @@ public Transaction newTransaction() {
    *
    * @see SQLiteDatabase#rawQuery(String, String[])
    */
-  @CheckResult
+  @CheckResult @NonNull
   public QueryObservable createQuery(@NonNull final String table, @NonNull String sql,
       @NonNull String... args) {
     Func1<Set<String>, Boolean> tableFilter = new Func1<Set<String>, Boolean>() {
@@ -245,7 +246,7 @@ public QueryObservable createQuery(@NonNull final String table, @NonNull String
    *
    * @see SQLiteDatabase#rawQuery(String, String[])
    */
-  @CheckResult
+  @CheckResult @NonNull
   public QueryObservable createQuery(@NonNull final Iterable<String> tables, @NonNull String sql,
       @NonNull String... args) {
     Func1<Set<String>, Boolean> tableFilter = new Func1<Set<String>, Boolean>() {
@@ -265,7 +266,7 @@ public QueryObservable createQuery(@NonNull final Iterable<String> tables, @NonN
     return createQuery(tableFilter, sql, args);
   }
 
-  @CheckResult
+  @CheckResult @NonNull
   private QueryObservable createQuery(final Func1<Set<String>, Boolean> tableFilter,
       final String sql, final String... args) {
     if (transactions.get() != null) {
@@ -426,6 +427,7 @@ public interface Transaction extends Closeable {
      *
      * @see SQLiteDatabase#endTransaction()
      */
+    @WorkerThread
     void end();
 
     /**
@@ -436,6 +438,7 @@ public interface Transaction extends Closeable {
      *
      * @see SQLiteDatabase#setTransactionSuccessful()
      */
+    @WorkerThread
     void markSuccessful();
 
     /**
@@ -472,6 +475,7 @@ public interface Transaction extends Closeable {
     /**
      * Equivalent to calling {@link #end()}
      */
+    @WorkerThread
     @Override void close();
   }
 

sqlbrite/src/main/java/com/squareup/sqlbrite/QueryObservable.java

@@ -36,7 +36,7 @@ public final class QueryObservable extends Observable<Query> {
    * }</pre>
    * Consider using {@link Query#asRows} if you need to limit or filter in memory.
    */
-  @CheckResult
+  @CheckResult @NonNull
   public final <T> Observable<List<T>> mapToList(@NonNull final Func1<Cursor, T> mapper) {
     return lift(new Operator<List<T>, Query>() {
       @Override

sqlbrite/src/main/java/com/squareup/sqlbrite/SqlBrite.java

@@ -31,7 +31,7 @@
  * the result of a query.
  */
 public final class SqlBrite {
-  @CheckResult
+  @CheckResult @NonNull
   public static SqlBrite create() {
     return create(new Logger() {
       @Override public void log(String message) {
@@ -40,7 +40,7 @@ public static SqlBrite create() {
     });
   }
 
-  @CheckResult
+  @CheckResult @NonNull
   public static SqlBrite create(@NonNull Logger logger) {
     return new SqlBrite(logger);
   }
@@ -59,13 +59,13 @@ private SqlBrite(@NonNull Logger logger) {
    * notifications of table changes to work. See {@linkplain BriteDatabase#createQuery the
    * <code>query</code> method} for more information on that behavior.
    */
-  @CheckResult
+  @CheckResult @NonNull
   public BriteDatabase wrapDatabaseHelper(@NonNull SQLiteOpenHelper helper) {
     return new BriteDatabase(helper, logger);
   }
 
   /** Wrap a {@link ContentResolver} for observable queries. */
-  @CheckResult
+  @CheckResult @NonNull
   public BriteContentResolver wrapContentProvider(@NonNull ContentResolver contentResolver) {
     return new BriteContentResolver(contentResolver, logger);
   }
@@ -74,6 +74,7 @@ public BriteContentResolver wrapContentProvider(@NonNull ContentResolver content
   public static abstract class Query {
     /** Execute the query on the underlying database and return the resulting cursor. */
     @CheckResult @WorkerThread
+    // TODO Implementations might return null, which is gross. Throw?
     public abstract Cursor run();
 
     /**
@@ -96,7 +97,7 @@ public static abstract class Query {
      * Note: Limiting results or filtering will almost always be faster in the database as part of
      * a query and should be preferred, where possible.
      */
-    @CheckResult
+    @CheckResult @NonNull
     public final <T> Observable<T> asRows(final Func1<Cursor, T> mapper) {
       return Observable.create(new Observable.OnSubscribe<T>() {
         @Override public void call(Subscriber<? super T> subscriber) {