Skip to content
This repository was archived by the owner on Aug 17, 2020. It is now read-only.

Commit e5d5cf5

Browse files
committed
Sprinkle more annotation vomit all over the public API.
1 parent f68ddb4 commit e5d5cf5

4 files changed

Lines changed: 15 additions & 10 deletions

File tree

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ public void setLoggingEnabled(boolean enabled) {
7171
* @see ContentResolver#query(Uri, String[], String, String[], String)
7272
* @see ContentResolver#registerContentObserver(Uri, boolean, ContentObserver)
7373
*/
74-
@CheckResult
74+
@CheckResult @NonNull
7575
public QueryObservable createQuery(@NonNull final Uri uri, @Nullable final String[] projection,
7676
@Nullable final String selection, @Nullable final String[] selectionArgs, @Nullable
7777
final String sortOrder, final boolean notifyForDescendents) {

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

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,7 @@ private void sendTableTrigger(Set<String> tables) {
187187
*
188188
* @see SQLiteDatabase#beginTransaction()
189189
*/
190+
@CheckResult @NonNull
190191
public Transaction newTransaction() {
191192
SqliteTransaction transaction = new SqliteTransaction(transactions.get());
192193
transactions.set(transaction);
@@ -224,7 +225,7 @@ public Transaction newTransaction() {
224225
*
225226
* @see SQLiteDatabase#rawQuery(String, String[])
226227
*/
227-
@CheckResult
228+
@CheckResult @NonNull
228229
public QueryObservable createQuery(@NonNull final String table, @NonNull String sql,
229230
@NonNull String... args) {
230231
Func1<Set<String>, Boolean> tableFilter = new Func1<Set<String>, Boolean>() {
@@ -245,7 +246,7 @@ public QueryObservable createQuery(@NonNull final String table, @NonNull String
245246
*
246247
* @see SQLiteDatabase#rawQuery(String, String[])
247248
*/
248-
@CheckResult
249+
@CheckResult @NonNull
249250
public QueryObservable createQuery(@NonNull final Iterable<String> tables, @NonNull String sql,
250251
@NonNull String... args) {
251252
Func1<Set<String>, Boolean> tableFilter = new Func1<Set<String>, Boolean>() {
@@ -265,7 +266,7 @@ public QueryObservable createQuery(@NonNull final Iterable<String> tables, @NonN
265266
return createQuery(tableFilter, sql, args);
266267
}
267268

268-
@CheckResult
269+
@CheckResult @NonNull
269270
private QueryObservable createQuery(final Func1<Set<String>, Boolean> tableFilter,
270271
final String sql, final String... args) {
271272
if (transactions.get() != null) {
@@ -426,6 +427,7 @@ public interface Transaction extends Closeable {
426427
*
427428
* @see SQLiteDatabase#endTransaction()
428429
*/
430+
@WorkerThread
429431
void end();
430432

431433
/**
@@ -436,6 +438,7 @@ public interface Transaction extends Closeable {
436438
*
437439
* @see SQLiteDatabase#setTransactionSuccessful()
438440
*/
441+
@WorkerThread
439442
void markSuccessful();
440443

441444
/**
@@ -472,6 +475,7 @@ public interface Transaction extends Closeable {
472475
/**
473476
* Equivalent to calling {@link #end()}
474477
*/
478+
@WorkerThread
475479
@Override void close();
476480
}
477481

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ public final class QueryObservable extends Observable<Query> {
3636
* }</pre>
3737
* Consider using {@link Query#asRows} if you need to limit or filter in memory.
3838
*/
39-
@CheckResult
39+
@CheckResult @NonNull
4040
public final <T> Observable<List<T>> mapToList(@NonNull final Func1<Cursor, T> mapper) {
4141
return lift(new Operator<List<T>, Query>() {
4242
@Override

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

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
* the result of a query.
3232
*/
3333
public final class SqlBrite {
34-
@CheckResult
34+
@CheckResult @NonNull
3535
public static SqlBrite create() {
3636
return create(new Logger() {
3737
@Override public void log(String message) {
@@ -40,7 +40,7 @@ public static SqlBrite create() {
4040
});
4141
}
4242

43-
@CheckResult
43+
@CheckResult @NonNull
4444
public static SqlBrite create(@NonNull Logger logger) {
4545
return new SqlBrite(logger);
4646
}
@@ -59,13 +59,13 @@ private SqlBrite(@NonNull Logger logger) {
5959
* notifications of table changes to work. See {@linkplain BriteDatabase#createQuery the
6060
* <code>query</code> method} for more information on that behavior.
6161
*/
62-
@CheckResult
62+
@CheckResult @NonNull
6363
public BriteDatabase wrapDatabaseHelper(@NonNull SQLiteOpenHelper helper) {
6464
return new BriteDatabase(helper, logger);
6565
}
6666

6767
/** Wrap a {@link ContentResolver} for observable queries. */
68-
@CheckResult
68+
@CheckResult @NonNull
6969
public BriteContentResolver wrapContentProvider(@NonNull ContentResolver contentResolver) {
7070
return new BriteContentResolver(contentResolver, logger);
7171
}
@@ -74,6 +74,7 @@ public BriteContentResolver wrapContentProvider(@NonNull ContentResolver content
7474
public static abstract class Query {
7575
/** Execute the query on the underlying database and return the resulting cursor. */
7676
@CheckResult @WorkerThread
77+
// TODO Implementations might return null, which is gross. Throw?
7778
public abstract Cursor run();
7879

7980
/**
@@ -96,7 +97,7 @@ public static abstract class Query {
9697
* Note: Limiting results or filtering will almost always be faster in the database as part of
9798
* a query and should be preferred, where possible.
9899
*/
99-
@CheckResult
100+
@CheckResult @NonNull
100101
public final <T> Observable<T> asRows(final Func1<Cursor, T> mapper) {
101102
return Observable.create(new Observable.OnSubscribe<T>() {
102103
@Override public void call(Subscriber<? super T> subscriber) {

0 commit comments

Comments
 (0)