Skip to content

Commit e35a73b

Browse files
SUPERCILEXsjudd
authored andcommitted
Finish adding nullability annotations to Registry class and its dependencies (#2746)
Signed-off-by: Alex Saveau <saveau.alexandre@gmail.com>
1 parent 0e3172a commit e35a73b

40 files changed

+174
-110
lines changed

instrumentation/src/androidTest/java/com/bumptech/glide/test/WaitModelLoader.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@ public static synchronized <T> WaitModel<T> waitOn(T model) {
8383
return new WaitModel<>(model);
8484
}
8585

86+
@NonNull
8687
@Override
8788
public ModelLoader<WaitModel<Model>, Data> build(
8889
MultiModelLoaderFactory multiFactory) {
@@ -106,7 +107,7 @@ private static final class WaitFetcher<Data> implements DataFetcher<Data> {
106107
}
107108

108109
@Override
109-
public void loadData(Priority priority, DataCallback<? super Data> callback) {
110+
public void loadData(@NonNull Priority priority, @NonNull DataCallback<? super Data> callback) {
110111
ConcurrencyHelper.waitOnLatch(toWaitOn);
111112
wrapped.loadData(priority, callback);
112113
}

integration/okhttp/src/main/java/com/bumptech/glide/integration/okhttp/OkHttpStreamFetcher.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@ public OkHttpStreamFetcher(OkHttpClient client, GlideUrl url) {
3838
}
3939

4040
@Override
41-
public void loadData(Priority priority, final DataCallback<? super InputStream> callback) {
41+
public void loadData(@NonNull Priority priority,
42+
@NonNull final DataCallback<? super InputStream> callback) {
4243
Request.Builder requestBuilder = new Request.Builder().url(url.toStringUrl());
4344
for (Map.Entry<String, String> headerEntry : url.getHeaders().entrySet()) {
4445
String key = headerEntry.getKey();

integration/okhttp/src/main/java/com/bumptech/glide/integration/okhttp/OkHttpUrlLoader.java

+5-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
package com.bumptech.glide.integration.okhttp;
22

3+
import android.support.annotation.NonNull;
34
import com.bumptech.glide.load.Options;
45
import com.bumptech.glide.load.model.GlideUrl;
56
import com.bumptech.glide.load.model.ModelLoader;
@@ -25,14 +26,14 @@ public OkHttpUrlLoader(OkHttpClient client) {
2526
}
2627

2728
@Override
28-
public boolean handles(GlideUrl url) {
29+
public boolean handles(@NonNull GlideUrl url) {
2930
return true;
3031
}
3132

3233
@SuppressWarnings("deprecation")
3334
@Override
34-
public LoadData<InputStream> buildLoadData(GlideUrl model, int width, int height,
35-
Options options) {
35+
public LoadData<InputStream> buildLoadData(@NonNull GlideUrl model, int width, int height,
36+
@NonNull Options options) {
3637
return new LoadData<>(model, new OkHttpStreamFetcher(client, model));
3738
}
3839

@@ -70,6 +71,7 @@ public Factory(OkHttpClient client) {
7071
this.client = client;
7172
}
7273

74+
@NonNull
7375
@SuppressWarnings("deprecation")
7476
@Override
7577
public ModelLoader<GlideUrl, InputStream> build(MultiModelLoaderFactory multiFactory) {

integration/okhttp3/src/main/java/com/bumptech/glide/integration/okhttp3/OkHttpStreamFetcher.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,7 @@
2222
/**
2323
* Fetches an {@link InputStream} using the okhttp library.
2424
*/
25-
public class OkHttpStreamFetcher implements DataFetcher<InputStream>,
26-
okhttp3.Callback {
25+
public class OkHttpStreamFetcher implements DataFetcher<InputStream>, okhttp3.Callback {
2726
private static final String TAG = "OkHttpFetcher";
2827
private final Call.Factory client;
2928
private final GlideUrl url;
@@ -40,7 +39,8 @@ public OkHttpStreamFetcher(Call.Factory client, GlideUrl url) {
4039
}
4140

4241
@Override
43-
public void loadData(Priority priority, final DataCallback<? super InputStream> callback) {
42+
public void loadData(@NonNull Priority priority,
43+
@NonNull final DataCallback<? super InputStream> callback) {
4444
Request.Builder requestBuilder = new Request.Builder().url(url.toStringUrl());
4545
for (Map.Entry<String, String> headerEntry : url.getHeaders().entrySet()) {
4646
String key = headerEntry.getKey();

integration/volley/src/main/java/com/bumptech/glide/integration/volley/VolleyStreamFetcher.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
import android.support.annotation.NonNull;
44
import android.util.Log;
5-
import com.android.volley.AuthFailureError;
65
import com.android.volley.NetworkResponse;
76
import com.android.volley.Request;
87
import com.android.volley.RequestQueue;
@@ -51,7 +50,8 @@ public VolleyStreamFetcher(RequestQueue requestQueue, GlideUrl url,
5150
}
5251

5352
@Override
54-
public void loadData(Priority priority, DataCallback<? super InputStream> callback) {
53+
public void loadData(@NonNull Priority priority,
54+
@NonNull DataCallback<? super InputStream> callback) {
5555
request = requestFactory.create(url.toStringUrl(), callback, glideToVolleyPriority(priority),
5656
url.getHeaders());
5757
requestQueue.add(request);
@@ -82,7 +82,7 @@ public DataSource getDataSource() {
8282
return DataSource.REMOTE;
8383
}
8484

85-
private static Request.Priority glideToVolleyPriority(Priority priority) {
85+
private static Request.Priority glideToVolleyPriority(@NonNull Priority priority) {
8686
switch (priority) {
8787
case LOW:
8888
return Request.Priority.LOW;
@@ -119,7 +119,7 @@ public GlideRequest(String url, DataCallback<? super InputStream> callback, Prio
119119
}
120120

121121
@Override
122-
public Map<String, String> getHeaders() throws AuthFailureError {
122+
public Map<String, String> getHeaders() {
123123
return headers;
124124
}
125125

integration/volley/src/main/java/com/bumptech/glide/integration/volley/VolleyUrlLoader.java

+1
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ public Factory(RequestQueue requestQueue, VolleyRequestFactory requestFactory) {
7777
this.requestQueue = requestQueue;
7878
}
7979

80+
@NonNull
8081
@Override
8182
public ModelLoader<GlideUrl, InputStream> build(MultiModelLoaderFactory factory) {
8283
return new VolleyUrlLoader(requestQueue, requestFactory);

library/src/main/java/com/bumptech/glide/Registry.java

+16-13
Original file line numberDiff line numberDiff line change
@@ -398,8 +398,9 @@ public Registry register(@NonNull ImageHeaderParser parser) {
398398
* {@link java.io.FileDescriptor}).
399399
*/
400400
@NonNull
401-
public <Model, Data> Registry append(Class<Model> modelClass, Class<Data> dataClass,
402-
ModelLoaderFactory<Model, Data> factory) {
401+
public <Model, Data> Registry append(
402+
@NonNull Class<Model> modelClass, @NonNull Class<Data> dataClass,
403+
@NonNull ModelLoaderFactory<Model, Data> factory) {
403404
modelLoaderRegistry.append(modelClass, dataClass, factory);
404405
return this;
405406
}
@@ -428,8 +429,9 @@ public <Model, Data> Registry append(Class<Model> modelClass, Class<Data> dataCl
428429
* {@link java.io.FileDescriptor}).
429430
*/
430431
@NonNull
431-
public <Model, Data> Registry prepend(Class<Model> modelClass, Class<Data> dataClass,
432-
ModelLoaderFactory<Model, Data> factory) {
432+
public <Model, Data> Registry prepend(
433+
@NonNull Class<Model> modelClass, @NonNull Class<Data> dataClass,
434+
@NonNull ModelLoaderFactory<Model, Data> factory) {
433435
modelLoaderRegistry.prepend(modelClass, dataClass, factory);
434436
return this;
435437
}
@@ -459,9 +461,9 @@ public <Model, Data> Registry prepend(Class<Model> modelClass, Class<Data> dataC
459461
*/
460462
@NonNull
461463
public <Model, Data> Registry replace(
462-
Class<Model> modelClass,
463-
Class<Data> dataClass,
464-
ModelLoaderFactory<? extends Model, ? extends Data> factory) {
464+
@NonNull Class<Model> modelClass,
465+
@NonNull Class<Data> dataClass,
466+
@NonNull ModelLoaderFactory<? extends Model, ? extends Data> factory) {
465467
modelLoaderRegistry.replace(modelClass, dataClass, factory);
466468
return this;
467469
}
@@ -518,7 +520,7 @@ private <Data, TResource, Transcode> List<DecodePath<Data, TResource, Transcode>
518520

519521
@Nullable
520522
public <Model, TResource, Transcode> List<Class<?>> getRegisteredResourceClasses(
521-
Class<Model> modelClass, @NonNull Class<TResource> resourceClass,
523+
@NonNull Class<Model> modelClass, @NonNull Class<TResource> resourceClass,
522524
@NonNull Class<Transcode> transcodeClass) {
523525
List<Class<?>> result = modelToResourceClassCache.get(modelClass, resourceClass);
524526

@@ -597,11 +599,12 @@ public List<ImageHeaderParser> getImageHeaderParsers() {
597599
// Never serialized by Glide.
598600
@SuppressWarnings("serial")
599601
public static class NoModelLoaderAvailableException extends MissingComponentException {
600-
public NoModelLoaderAvailableException(Object model) {
602+
public NoModelLoaderAvailableException(@NonNull Object model) {
601603
super("Failed to find any ModelLoaders for model: " + model);
602604
}
603605

604-
public NoModelLoaderAvailableException(Class<?> modelClass, Class<?> dataClass) {
606+
public NoModelLoaderAvailableException(@NonNull Class<?> modelClass,
607+
@NonNull Class<?> dataClass) {
605608
super("Failed to find any ModelLoaders for model: " + modelClass + " and data: " + dataClass);
606609
}
607610
}
@@ -612,7 +615,7 @@ public NoModelLoaderAvailableException(Class<?> modelClass, Class<?> dataClass)
612615
// Never serialized by Glide.
613616
@SuppressWarnings("serial")
614617
public static class NoResultEncoderAvailableException extends MissingComponentException {
615-
public NoResultEncoderAvailableException(Class<?> resourceClass) {
618+
public NoResultEncoderAvailableException(@NonNull Class<?> resourceClass) {
616619
super("Failed to find result encoder for resource class: " + resourceClass);
617620
}
618621
}
@@ -623,7 +626,7 @@ public NoResultEncoderAvailableException(Class<?> resourceClass) {
623626
// Never serialized by Glide.
624627
@SuppressWarnings("serial")
625628
public static class NoSourceEncoderAvailableException extends MissingComponentException {
626-
public NoSourceEncoderAvailableException(Class<?> dataClass) {
629+
public NoSourceEncoderAvailableException(@NonNull Class<?> dataClass) {
627630
super("Failed to find source encoder for data class: " + dataClass);
628631
}
629632
}
@@ -634,7 +637,7 @@ public NoSourceEncoderAvailableException(Class<?> dataClass) {
634637
// Never serialized by Glide.
635638
@SuppressWarnings("serial")
636639
public static class MissingComponentException extends RuntimeException {
637-
public MissingComponentException(String message) {
640+
public MissingComponentException(@NonNull String message) {
638641
super(message);
639642
}
640643
}

library/src/main/java/com/bumptech/glide/load/data/AssetPathFetcher.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ public AssetPathFetcher(AssetManager assetManager, String assetPath) {
2727
}
2828

2929
@Override
30-
public void loadData(Priority priority, DataCallback<? super T> callback) {
30+
public void loadData(@NonNull Priority priority, @NonNull DataCallback<? super T> callback) {
3131
try {
3232
data = loadResource(assetManager, assetPath);
3333
} catch (IOException e) {

library/src/main/java/com/bumptech/glide/load/data/DataFetcher.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ interface DataCallback<T> {
3939
*
4040
* @param e a non-null {@link Exception} indicating why the load failed.
4141
*/
42-
void onLoadFailed(Exception e);
42+
void onLoadFailed(@NonNull Exception e);
4343
}
4444

4545
/**
@@ -63,7 +63,7 @@ interface DataCallback<T> {
6363
* @param callback The callback to use when the request is complete
6464
* @see #cleanup() where the data retuned will be cleaned up
6565
*/
66-
void loadData(Priority priority, DataCallback<? super T> callback);
66+
void loadData(@NonNull Priority priority, @NonNull DataCallback<? super T> callback);
6767

6868
/**
6969
* Cleanup or recycle any resources used by this data fetcher. This method will be called in a

library/src/main/java/com/bumptech/glide/load/data/HttpUrlFetcher.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,8 @@ public HttpUrlFetcher(GlideUrl glideUrl, int timeout) {
4848
}
4949

5050
@Override
51-
public void loadData(Priority priority, DataCallback<? super InputStream> callback) {
51+
public void loadData(@NonNull Priority priority,
52+
@NonNull DataCallback<? super InputStream> callback) {
5253
long startTime = LogTime.getLogTime();
5354
final InputStream result;
5455
try {

library/src/main/java/com/bumptech/glide/load/data/LocalUriFetcher.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@ public LocalUriFetcher(ContentResolver contentResolver, Uri uri) {
3838
}
3939

4040
@Override
41-
public final void loadData(Priority priority, DataCallback<? super T> callback) {
41+
public final void loadData(@NonNull Priority priority,
42+
@NonNull DataCallback<? super T> callback) {
4243
try {
4344
data = loadResource(uri, contentResolver);
4445
} catch (FileNotFoundException e) {

library/src/main/java/com/bumptech/glide/load/data/mediastore/ThumbFetcher.java

+6-5
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,8 @@ private static ThumbFetcher build(Context context, Uri uri, ThumbnailQuery query
5252
}
5353

5454
@Override
55-
public void loadData(Priority priority, DataCallback<? super InputStream> callback) {
55+
public void loadData(@NonNull Priority priority,
56+
@NonNull DataCallback<? super InputStream> callback) {
5657
try {
5758
inputStream = openThumbInputStream();
5859
} catch (FileNotFoundException e) {
@@ -117,11 +118,11 @@ static class VideoThumbnailQuery implements ThumbnailQuery {
117118
}
118119

119120
private static final String[] PATH_PROJECTION = {
120-
MediaStore.Video.Thumbnails.DATA
121+
MediaStore.Video.Thumbnails.DATA
121122
};
122123
private static final String PATH_SELECTION =
123124
MediaStore.Video.Thumbnails.KIND + " = " + MediaStore.Video.Thumbnails.MINI_KIND
124-
+ " AND " + MediaStore.Video.Thumbnails.VIDEO_ID + " = ?";
125+
+ " AND " + MediaStore.Video.Thumbnails.VIDEO_ID + " = ?";
125126

126127
@Override
127128
public Cursor query(Uri uri) {
@@ -145,11 +146,11 @@ static class ImageThumbnailQuery implements ThumbnailQuery {
145146
}
146147

147148
private static final String[] PATH_PROJECTION = {
148-
MediaStore.Images.Thumbnails.DATA,
149+
MediaStore.Images.Thumbnails.DATA,
149150
};
150151
private static final String PATH_SELECTION =
151152
MediaStore.Images.Thumbnails.KIND + " = " + MediaStore.Images.Thumbnails.MINI_KIND
152-
+ " AND " + MediaStore.Images.Thumbnails.IMAGE_ID + " = ?";
153+
+ " AND " + MediaStore.Images.Thumbnails.IMAGE_ID + " = ?";
153154

154155
@Override
155156
public Cursor query(Uri uri) {

library/src/main/java/com/bumptech/glide/load/engine/DataCacheGenerator.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
package com.bumptech.glide.load.engine;
22

3+
import android.support.annotation.NonNull;
34
import com.bumptech.glide.load.DataSource;
45
import com.bumptech.glide.load.Key;
56
import com.bumptech.glide.load.data.DataFetcher;
@@ -92,7 +93,7 @@ public void onDataReady(Object data) {
9293
}
9394

9495
@Override
95-
public void onLoadFailed(Exception e) {
96+
public void onLoadFailed(@NonNull Exception e) {
9697
cb.onDataFetcherFailed(sourceKey, e, loadData.fetcher, DataSource.DATA_DISK_CACHE);
9798
}
9899
}

library/src/main/java/com/bumptech/glide/load/engine/ResourceCacheGenerator.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
package com.bumptech.glide.load.engine;
22

3+
import android.support.annotation.NonNull;
34
import com.bumptech.glide.load.DataSource;
45
import com.bumptech.glide.load.Key;
56
import com.bumptech.glide.load.Transformation;
@@ -110,7 +111,7 @@ public void onDataReady(Object data) {
110111
}
111112

112113
@Override
113-
public void onLoadFailed(Exception e) {
114+
public void onLoadFailed(@NonNull Exception e) {
114115
cb.onDataFetcherFailed(currentKey, e, loadData.fetcher, DataSource.RESOURCE_DISK_CACHE);
115116
}
116117
}

library/src/main/java/com/bumptech/glide/load/engine/SourceGenerator.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
package com.bumptech.glide.load.engine;
22

3+
import android.support.annotation.NonNull;
34
import android.util.Log;
45
import com.bumptech.glide.load.DataSource;
56
import com.bumptech.glide.load.Encoder;
@@ -114,7 +115,7 @@ public void onDataReady(Object data) {
114115
}
115116

116117
@Override
117-
public void onLoadFailed(Exception e) {
118+
public void onLoadFailed(@NonNull Exception e) {
118119
cb.onDataFetcherFailed(originalKey, e, loadData.fetcher, loadData.fetcher.getDataSource());
119120
}
120121

library/src/main/java/com/bumptech/glide/load/model/AssetUriLoader.java

+2
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ public StreamFactory(AssetManager assetManager) {
6767
this.assetManager = assetManager;
6868
}
6969

70+
@NonNull
7071
@Override
7172
public ModelLoader<Uri, InputStream> build(MultiModelLoaderFactory multiFactory) {
7273
return new AssetUriLoader<>(assetManager, this);
@@ -96,6 +97,7 @@ public FileDescriptorFactory(AssetManager assetManager) {
9697
this.assetManager = assetManager;
9798
}
9899

100+
@NonNull
99101
@Override
100102
public ModelLoader<Uri, ParcelFileDescriptor> build(MultiModelLoaderFactory multiFactory) {
101103
return new AssetUriLoader<>(assetManager, this);

library/src/main/java/com/bumptech/glide/load/model/ByteArrayLoader.java

+3-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ private static class Fetcher<Data> implements DataFetcher<Data> {
5656
}
5757

5858
@Override
59-
public void loadData(Priority priority, DataCallback<? super Data> callback) {
59+
public void loadData(@NonNull Priority priority, @NonNull DataCallback<? super Data> callback) {
6060
Data result = converter.convert(model);
6161
callback.onDataReady(result);
6262
}
@@ -90,6 +90,7 @@ public DataSource getDataSource() {
9090
*/
9191
public static class ByteBufferFactory implements ModelLoaderFactory<byte[], ByteBuffer> {
9292

93+
@NonNull
9394
@Override
9495
public ModelLoader<byte[], ByteBuffer> build(MultiModelLoaderFactory multiFactory) {
9596
return new ByteArrayLoader<>(new Converter<ByteBuffer>() {
@@ -116,6 +117,7 @@ public void teardown() {
116117
*/
117118
public static class StreamFactory implements ModelLoaderFactory<byte[], InputStream> {
118119

120+
@NonNull
119121
@Override
120122
public ModelLoader<byte[], InputStream> build(MultiModelLoaderFactory multiFactory) {
121123
return new ByteArrayLoader<>(new Converter<InputStream>() {

0 commit comments

Comments
 (0)