Skip to content

Commit c310780

Browse files
SUPERCILEXsjudd
SUPERCILEX
authored and
sjudd
committed
Add nullability annotations to signature package and its dependencies (#2748)
Signed-off-by: Alex Saveau <saveau.alexandre@gmail.com>
1 parent 276d4ff commit c310780

24 files changed

+55
-39
lines changed

‎library/src/main/java/com/bumptech/glide/load/Key.java

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

3+
import android.support.annotation.NonNull;
34
import java.nio.charset.Charset;
45
import java.security.MessageDigest;
56

@@ -21,7 +22,7 @@ public interface Key {
2122
* <p> Note - Using {@link java.security.MessageDigest#reset()} inside of this method will result
2223
* in undefined behavior. </p>
2324
*/
24-
void updateDiskCacheKey(MessageDigest messageDigest);
25+
void updateDiskCacheKey(@NonNull MessageDigest messageDigest);
2526

2627
@Override
2728
boolean equals(Object o);

‎library/src/main/java/com/bumptech/glide/load/MultiTransformation.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ public int hashCode() {
6464
}
6565

6666
@Override
67-
public void updateDiskCacheKey(MessageDigest messageDigest) {
67+
public void updateDiskCacheKey(@NonNull MessageDigest messageDigest) {
6868
for (Transformation<T> transformation : transformations) {
6969
transformation.updateDiskCacheKey(messageDigest);
7070
}

‎library/src/main/java/com/bumptech/glide/load/Options.java

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

3+
import android.support.annotation.NonNull;
34
import android.support.v4.util.ArrayMap;
45
import android.support.v4.util.SimpleArrayMap;
56
import java.security.MessageDigest;
@@ -39,7 +40,7 @@ public int hashCode() {
3940
}
4041

4142
@Override
42-
public void updateDiskCacheKey(MessageDigest messageDigest) {
43+
public void updateDiskCacheKey(@NonNull MessageDigest messageDigest) {
4344
for (int i = 0; i < values.size(); i++) {
4445
Option<?> key = values.keyAt(i);
4546
Object value = values.valueAt(i);

‎library/src/main/java/com/bumptech/glide/load/engine/DataCacheKey.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.Key;
45
import java.security.MessageDigest;
56

@@ -45,7 +46,7 @@ public String toString() {
4546
}
4647

4748
@Override
48-
public void updateDiskCacheKey(MessageDigest messageDigest) {
49+
public void updateDiskCacheKey(@NonNull MessageDigest messageDigest) {
4950
sourceKey.updateDiskCacheKey(messageDigest);
5051
signature.updateDiskCacheKey(messageDigest);
5152
}

‎library/src/main/java/com/bumptech/glide/load/engine/EngineKey.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.Key;
45
import com.bumptech.glide.load.Options;
56
import com.bumptech.glide.load.Transformation;
@@ -89,7 +90,7 @@ public String toString() {
8990
}
9091

9192
@Override
92-
public void updateDiskCacheKey(MessageDigest messageDigest) {
93+
public void updateDiskCacheKey(@NonNull MessageDigest messageDigest) {
9394
throw new UnsupportedOperationException();
9495
}
9596
}

‎library/src/main/java/com/bumptech/glide/load/engine/ResourceCacheKey.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.Key;
45
import com.bumptech.glide.load.Options;
56
import com.bumptech.glide.load.Transformation;
@@ -72,7 +73,7 @@ public int hashCode() {
7273

7374
// TODO: Include relevant options?
7475
@Override
75-
public void updateDiskCacheKey(MessageDigest messageDigest) {
76+
public void updateDiskCacheKey(@NonNull MessageDigest messageDigest) {
7677
byte[] dimensions = arrayPool.getExact(8, byte[].class);
7778
ByteBuffer.wrap(dimensions).putInt(width).putInt(height).array();
7879
signature.updateDiskCacheKey(messageDigest);

‎library/src/main/java/com/bumptech/glide/load/engine/prefill/BitmapPreFillRunner.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
import android.os.Handler;
55
import android.os.Looper;
66
import android.os.SystemClock;
7+
import android.support.annotation.NonNull;
78
import android.support.annotation.VisibleForTesting;
89
import android.util.Log;
910
import com.bumptech.glide.load.Key;
@@ -165,7 +166,7 @@ private static final class UniqueKey implements Key {
165166
UniqueKey() { }
166167

167168
@Override
168-
public void updateDiskCacheKey(MessageDigest messageDigest) {
169+
public void updateDiskCacheKey(@NonNull MessageDigest messageDigest) {
169170
throw new UnsupportedOperationException();
170171
}
171172
}

‎library/src/main/java/com/bumptech/glide/load/model/GlideUrl.java

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

33
import android.net.Uri;
4+
import android.support.annotation.NonNull;
45
import android.support.annotation.Nullable;
56
import android.text.TextUtils;
67
import com.bumptech.glide.load.Key;
@@ -120,7 +121,7 @@ public String toString() {
120121
}
121122

122123
@Override
123-
public void updateDiskCacheKey(MessageDigest messageDigest) {
124+
public void updateDiskCacheKey(@NonNull MessageDigest messageDigest) {
124125
messageDigest.update(getCacheKeyBytes());
125126
}
126127

‎library/src/main/java/com/bumptech/glide/load/resource/UnitTransformation.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ public Resource<T> transform(@NonNull Context context, @NonNull Resource<T> reso
3636
}
3737

3838
@Override
39-
public void updateDiskCacheKey(MessageDigest messageDigest) {
39+
public void updateDiskCacheKey(@NonNull MessageDigest messageDigest) {
4040
// Do nothing.
4141
}
4242

‎library/src/main/java/com/bumptech/glide/load/resource/bitmap/BitmapDrawableTransformation.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
import android.graphics.Bitmap;
55
import android.graphics.drawable.BitmapDrawable;
66
import android.graphics.drawable.Drawable;
7+
import android.support.annotation.NonNull;
78
import com.bumptech.glide.load.Transformation;
89
import com.bumptech.glide.load.engine.Resource;
910
import com.bumptech.glide.load.engine.bitmap_recycle.BitmapPool;
@@ -90,7 +91,7 @@ public int hashCode() {
9091
}
9192

9293
@Override
93-
public void updateDiskCacheKey(MessageDigest messageDigest) {
94+
public void updateDiskCacheKey(@NonNull MessageDigest messageDigest) {
9495
wrapped.updateDiskCacheKey(messageDigest);
9596
}
9697
}

‎library/src/main/java/com/bumptech/glide/load/resource/bitmap/CenterCrop.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ public int hashCode() {
3535
}
3636

3737
@Override
38-
public void updateDiskCacheKey(MessageDigest messageDigest) {
38+
public void updateDiskCacheKey(@NonNull MessageDigest messageDigest) {
3939
messageDigest.update(ID_BYTES);
4040
}
4141
}

‎library/src/main/java/com/bumptech/glide/load/resource/bitmap/CenterInside.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ public int hashCode() {
3333
}
3434

3535
@Override
36-
public void updateDiskCacheKey(MessageDigest messageDigest) {
36+
public void updateDiskCacheKey(@NonNull MessageDigest messageDigest) {
3737
messageDigest.update(ID_BYTES);
3838
}
3939
}

‎library/src/main/java/com/bumptech/glide/load/resource/bitmap/CircleCrop.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ public int hashCode() {
3737
}
3838

3939
@Override
40-
public void updateDiskCacheKey(MessageDigest messageDigest) {
40+
public void updateDiskCacheKey(@NonNull MessageDigest messageDigest) {
4141
messageDigest.update(ID_BYTES);
4242
}
4343
}

‎library/src/main/java/com/bumptech/glide/load/resource/bitmap/DrawableTransformation.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ public int hashCode() {
9292
}
9393

9494
@Override
95-
public void updateDiskCacheKey(MessageDigest messageDigest) {
95+
public void updateDiskCacheKey(@NonNull MessageDigest messageDigest) {
9696
wrapped.updateDiskCacheKey(messageDigest);
9797
}
9898
}

‎library/src/main/java/com/bumptech/glide/load/resource/bitmap/FitCenter.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ public int hashCode() {
3131
}
3232

3333
@Override
34-
public void updateDiskCacheKey(MessageDigest messageDigest) {
34+
public void updateDiskCacheKey(@NonNull MessageDigest messageDigest) {
3535
messageDigest.update(ID_BYTES);
3636
}
3737
}

‎library/src/main/java/com/bumptech/glide/load/resource/bitmap/RoundedCorners.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ public int hashCode() {
4848
}
4949

5050
@Override
51-
public void updateDiskCacheKey(MessageDigest messageDigest) {
51+
public void updateDiskCacheKey(@NonNull MessageDigest messageDigest) {
5252
messageDigest.update(ID_BYTES);
5353

5454
byte[] radiusData = ByteBuffer.allocate(4).putInt(roundingRadius).array();

‎library/src/main/java/com/bumptech/glide/load/resource/gif/GifDrawableTransformation.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ public int hashCode() {
8181
}
8282

8383
@Override
84-
public void updateDiskCacheKey(MessageDigest messageDigest) {
84+
public void updateDiskCacheKey(@NonNull MessageDigest messageDigest) {
8585
wrapped.updateDiskCacheKey(messageDigest);
8686
}
8787
}

‎library/src/main/java/com/bumptech/glide/signature/ApplicationVersionSignature.java

+5-2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
import android.content.Context;
44
import android.content.pm.PackageInfo;
55
import android.content.pm.PackageManager;
6+
import android.support.annotation.NonNull;
67
import android.support.annotation.VisibleForTesting;
78
import com.bumptech.glide.load.Key;
89
import java.util.UUID;
@@ -20,7 +21,8 @@ public final class ApplicationVersionSignature {
2021
* Returns the signature {@link com.bumptech.glide.load.Key} for version code of the Application
2122
* of the given Context.
2223
*/
23-
public static Key obtain(Context context) {
24+
@NonNull
25+
public static Key obtain(@NonNull Context context) {
2426
String packageName = context.getPackageName();
2527
Key result = PACKAGE_NAME_TO_KEY.get(packageName);
2628
if (result == null) {
@@ -40,7 +42,8 @@ static void reset() {
4042
PACKAGE_NAME_TO_KEY.clear();
4143
}
4244

43-
private static Key obtainVersionSignature(Context context) {
45+
@NonNull
46+
private static Key obtainVersionSignature(@NonNull Context context) {
4447
PackageInfo pInfo = null;
4548
try {
4649
pInfo = context.getPackageManager().getPackageInfo(context.getPackageName(), 0);

‎library/src/main/java/com/bumptech/glide/signature/EmptySignature.java

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

3+
import android.support.annotation.NonNull;
34
import com.bumptech.glide.load.Key;
45
import java.security.MessageDigest;
56

@@ -9,6 +10,7 @@
910
public final class EmptySignature implements Key {
1011
private static final EmptySignature EMPTY_KEY = new EmptySignature();
1112

13+
@NonNull
1214
public static EmptySignature obtain() {
1315
return EMPTY_KEY;
1416
}
@@ -23,7 +25,7 @@ public String toString() {
2325
}
2426

2527
@Override
26-
public void updateDiskCacheKey(MessageDigest messageDigest) {
28+
public void updateDiskCacheKey(@NonNull MessageDigest messageDigest) {
2729
// Do nothing.
2830
}
2931
}

‎library/src/main/java/com/bumptech/glide/signature/MediaStoreSignature.java

+8-7
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
package com.bumptech.glide.signature;
22

3+
import android.support.annotation.NonNull;
4+
import android.support.annotation.Nullable;
35
import com.bumptech.glide.load.Key;
4-
import com.bumptech.glide.util.Util;
56
import java.nio.ByteBuffer;
67
import java.security.MessageDigest;
78

@@ -10,7 +11,7 @@
1011
* media store files like edits, rotations, and temporary file replacement.
1112
*/
1213
public class MediaStoreSignature implements Key {
13-
private final String mimeType;
14+
@NonNull private final String mimeType;
1415
private final long dateModified;
1516
private final int orientation;
1617

@@ -26,8 +27,8 @@ public class MediaStoreSignature implements Key {
2627
* @param orientation The orientation of the media store media. Ok to default to 0. See {@link
2728
* android.provider.MediaStore.Images.ImageColumns#ORIENTATION}.
2829
*/
29-
public MediaStoreSignature(String mimeType, long dateModified, int orientation) {
30-
this.mimeType = mimeType;
30+
public MediaStoreSignature(@Nullable String mimeType, long dateModified, int orientation) {
31+
this.mimeType = mimeType == null ? "" : mimeType;
3132
this.dateModified = dateModified;
3233
this.orientation = orientation;
3334
}
@@ -50,22 +51,22 @@ public boolean equals(Object o) {
5051
if (orientation != that.orientation) {
5152
return false;
5253
}
53-
if (!Util.bothNullOrEqual(mimeType, that.mimeType)) {
54+
if (!mimeType.equals(that.mimeType)) {
5455
return false;
5556
}
5657
return true;
5758
}
5859

5960
@Override
6061
public int hashCode() {
61-
int result = mimeType != null ? mimeType.hashCode() : 0;
62+
int result = mimeType.hashCode();
6263
result = 31 * result + (int) (dateModified ^ (dateModified >>> 32));
6364
result = 31 * result + orientation;
6465
return result;
6566
}
6667

6768
@Override
68-
public void updateDiskCacheKey(MessageDigest messageDigest) {
69+
public void updateDiskCacheKey(@NonNull MessageDigest messageDigest) {
6970
byte[] data = ByteBuffer.allocate(12).putLong(dateModified).putInt(orientation).array();
7071
messageDigest.update(data);
7172
messageDigest.update(mimeType.getBytes(CHARSET));

‎library/src/main/java/com/bumptech/glide/signature/ObjectKey.java

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

3+
import android.support.annotation.NonNull;
34
import com.bumptech.glide.load.Key;
45
import com.bumptech.glide.util.Preconditions;
56
import java.security.MessageDigest;
@@ -16,7 +17,7 @@
1617
public final class ObjectKey implements Key {
1718
private final Object object;
1819

19-
public ObjectKey(Object object) {
20+
public ObjectKey(@NonNull Object object) {
2021
this.object = Preconditions.checkNotNull(object);
2122
}
2223

@@ -42,7 +43,7 @@ public int hashCode() {
4243
}
4344

4445
@Override
45-
public void updateDiskCacheKey(MessageDigest messageDigest) {
46+
public void updateDiskCacheKey(@NonNull MessageDigest messageDigest) {
4647
messageDigest.update(object.toString().getBytes(CHARSET));
4748
}
4849
}

‎library/src/test/java/com/bumptech/glide/load/engine/cache/LruResourceCacheTest.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ private Resource<?> getResource(int size) {
181181

182182
private static class MockKey implements Key {
183183
@Override
184-
public void updateDiskCacheKey(MessageDigest messageDigest) {
184+
public void updateDiskCacheKey(@NonNull MessageDigest messageDigest) {
185185
messageDigest.update(toString().getBytes(CHARSET));
186186
}
187187
}

‎library/src/test/java/com/bumptech/glide/load/engine/cache/SafeKeyGeneratorTest.java

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

33
import static org.junit.Assert.assertTrue;
44

5+
import android.support.annotation.NonNull;
56
import com.bumptech.glide.load.Key;
67
import java.security.MessageDigest;
78
import java.util.regex.Matcher;
@@ -19,7 +20,7 @@ public class SafeKeyGeneratorTest {
1920
private int nextId;
2021

2122
@Before
22-
public void setUp() throws Exception {
23+
public void setUp() {
2324
nextId = 0;
2425
keyGenerator = new SafeKeyGenerator();
2526
}
@@ -50,7 +51,7 @@ private static final class MockKey implements Key {
5051
}
5152

5253
@Override
53-
public void updateDiskCacheKey(MessageDigest messageDigest) {
54+
public void updateDiskCacheKey(@NonNull MessageDigest messageDigest) {
5455
messageDigest.update(id.getBytes(CHARSET));
5556
}
5657
}

0 commit comments

Comments
 (0)