Add @nonnull and @nullable annotations

PiperOrigin-RevId: 264624045

Author: cketcham

lib/java/com/google/android/material/circularreveal/CircularRevealCompat.java

@@ -22,6 +22,7 @@
 import android.animation.ObjectAnimator;
 import android.os.Build.VERSION;
 import android.os.Build.VERSION_CODES;
+import androidx.annotation.NonNull;
 import android.view.View;
 import android.view.ViewAnimationUtils;
 import com.google.android.material.circularreveal.CircularRevealWidget.CircularRevealEvaluator;
@@ -50,8 +51,9 @@ private CircularRevealCompat() {}
    * CircularRevealCompat#createCircularRevealListener(CircularRevealWidget)} and add the returned
    * AnimatorListener to this Animator or preferably to the overall AnimatorSet.
    */
+  @NonNull
   public static Animator createCircularReveal(
-      CircularRevealWidget view, float centerX, float centerY, float endRadius) {
+      @NonNull CircularRevealWidget view, float centerX, float centerY, float endRadius) {
     Animator revealInfoAnimator =
         ObjectAnimator.ofObject(
             view,
@@ -89,6 +91,7 @@ public static Animator createCircularReveal(
    * CircularRevealCompat#createCircularRevealListener(CircularRevealWidget)} and add the returned
    * AnimatorListener to this Animator or preferably to the overall AnimatorSet.
    */
+  @NonNull
   public static Animator createCircularReveal(
       CircularRevealWidget view, float centerX, float centerY, float startRadius, float endRadius) {
     Animator revealInfoAnimator =
@@ -114,7 +117,9 @@ public static Animator createCircularReveal(
    * Creates an AnimatorListener to be applied to either the Animator returned from {@link
    * #createCircularReveal} or preferably to the overall AnimatorSet.
    */
-  public static AnimatorListener createCircularRevealListener(final CircularRevealWidget view) {
+  @NonNull
+  public static AnimatorListener createCircularRevealListener(
+      @NonNull final CircularRevealWidget view) {
     return new AnimatorListenerAdapter() {
       @Override
       public void onAnimationStart(Animator animation) {

lib/java/com/google/android/material/circularreveal/CircularRevealFrameLayout.java

@@ -20,20 +20,21 @@
 import android.graphics.Canvas;
 import android.graphics.drawable.Drawable;
 import androidx.annotation.ColorInt;
+import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 import android.util.AttributeSet;
 import android.widget.FrameLayout;
 
 /** A CircularRevealWidget wrapper for {@link FrameLayout}. */
 public class CircularRevealFrameLayout extends FrameLayout implements CircularRevealWidget {
 
-  private final CircularRevealHelper helper;
+  @NonNull private final CircularRevealHelper helper;
 
-  public CircularRevealFrameLayout(Context context) {
+  public CircularRevealFrameLayout(@NonNull Context context) {
     this(context, null);
   }
 
-  public CircularRevealFrameLayout(Context context, AttributeSet attrs) {
+  public CircularRevealFrameLayout(@NonNull Context context, @Nullable AttributeSet attrs) {
     super(context, attrs);
     helper = new CircularRevealHelper(this);
   }
@@ -82,7 +83,7 @@ public void setCircularRevealOverlayDrawable(@Nullable Drawable drawable) {
 
   @SuppressLint("MissingSuperCall")
   @Override
-  public void draw(Canvas canvas) {
+  public void draw(@NonNull Canvas canvas) {
     if (helper != null) {
       helper.draw(canvas);
     } else {

lib/java/com/google/android/material/circularreveal/CircularRevealGridLayout.java

@@ -19,14 +19,15 @@
 import android.graphics.Canvas;
 import android.graphics.drawable.Drawable;
 import androidx.annotation.ColorInt;
+import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 import android.util.AttributeSet;
 import android.widget.GridLayout;
 
 /** A CircularRevealWidget wrapper for {@link GridLayout}. */
 public class CircularRevealGridLayout extends GridLayout implements CircularRevealWidget {
 
-  private final CircularRevealHelper helper;
+  @NonNull private final CircularRevealHelper helper;
 
   public CircularRevealGridLayout(Context context) {
     this(context, null);
@@ -80,7 +81,7 @@ public void setCircularRevealOverlayDrawable(@Nullable Drawable drawable) {
   }
 
   @Override
-  public void draw(Canvas canvas) {
+  public void draw(@NonNull Canvas canvas) {
     if (helper != null) {
       helper.draw(canvas);
     } else {

lib/java/com/google/android/material/circularreveal/CircularRevealHelper.java

@@ -33,6 +33,7 @@
 import android.os.Build.VERSION_CODES;
 import androidx.annotation.ColorInt;
 import androidx.annotation.IntDef;
+import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 import android.view.View;
 import com.google.android.material.circularreveal.CircularRevealWidget.RevealInfo;
@@ -100,10 +101,10 @@ public interface Delegate {
   @Strategy public static final int STRATEGY;
 
   private final Delegate delegate;
-  private final View view;
-  private final Path revealPath;
-  private final Paint revealPaint;
-  private final Paint scrimPaint;
+  @NonNull private final View view;
+  @NonNull private final Path revealPath;
+  @NonNull private final Paint revealPaint;
+  @NonNull private final Paint scrimPaint;
   /**
    * The circular reveal representation which affects how the current frame will be drawn.
    *
@@ -249,12 +250,12 @@ private void invalidateRevealInfo() {
     view.invalidate();
   }
 
-  private float getDistanceToFurthestCorner(RevealInfo revealInfo) {
+  private float getDistanceToFurthestCorner(@NonNull RevealInfo revealInfo) {
     return MathUtils.distanceToFurthestCorner(
         revealInfo.centerX, revealInfo.centerY, 0, 0, view.getWidth(), view.getHeight());
   }
 
-  public void draw(Canvas canvas) {
+  public void draw(@NonNull Canvas canvas) {
     if (DEBUG) {
       drawDebugMode(canvas);
       return;
@@ -299,7 +300,7 @@ public void draw(Canvas canvas) {
     drawOverlayDrawable(canvas);
   }
 
-  private void drawOverlayDrawable(Canvas canvas) {
+  private void drawOverlayDrawable(@NonNull Canvas canvas) {
     if (shouldDrawOverlayDrawable()) {
       Rect bounds = overlayDrawable.getBounds();
       float translationX = revealInfo.centerX - bounds.width() / 2f;
@@ -332,7 +333,7 @@ private boolean shouldDrawOverlayDrawable() {
     return !buildingCircularRevealCache && overlayDrawable != null && revealInfo != null;
   }
 
-  private void drawDebugMode(Canvas canvas) {
+  private void drawDebugMode(@NonNull Canvas canvas) {
     delegate.actualDraw(canvas);
     if (shouldDrawScrim()) {
       canvas.drawCircle(revealInfo.centerX, revealInfo.centerY, revealInfo.radius, scrimPaint);
@@ -347,7 +348,7 @@ private void drawDebugMode(Canvas canvas) {
     drawOverlayDrawable(canvas);
   }
 
-  private void drawDebugCircle(Canvas canvas, int color, float width) {
+  private void drawDebugCircle(@NonNull Canvas canvas, int color, float width) {
     debugPaint.setColor(color);
     debugPaint.setStrokeWidth(width);
     canvas.drawCircle(

lib/java/com/google/android/material/circularreveal/CircularRevealLinearLayout.java

@@ -19,14 +19,15 @@
 import android.graphics.Canvas;
 import android.graphics.drawable.Drawable;
 import androidx.annotation.ColorInt;
+import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 import android.util.AttributeSet;
 import android.widget.LinearLayout;
 
 /** A CircularRevealWidget wrapper for {@link LinearLayout}. */
 public class CircularRevealLinearLayout extends LinearLayout implements CircularRevealWidget {
 
-  private final CircularRevealHelper helper;
+  @NonNull private final CircularRevealHelper helper;
 
   public CircularRevealLinearLayout(Context context) {
     this(context, null);
@@ -80,7 +81,7 @@ public void setCircularRevealOverlayDrawable(@Nullable Drawable drawable) {
   }
 
   @Override
-  public void draw(Canvas canvas) {
+  public void draw(@NonNull Canvas canvas) {
     if (helper != null) {
       helper.draw(canvas);
     } else {

lib/java/com/google/android/material/circularreveal/CircularRevealRelativeLayout.java

@@ -19,14 +19,15 @@
 import android.graphics.Canvas;
 import android.graphics.drawable.Drawable;
 import androidx.annotation.ColorInt;
+import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 import android.util.AttributeSet;
 import android.widget.RelativeLayout;
 
 /** A CircularRevealWidget wrapper for {@link RelativeLayout}. */
 public class CircularRevealRelativeLayout extends RelativeLayout implements CircularRevealWidget {
 
-  private final CircularRevealHelper helper;
+  @NonNull private final CircularRevealHelper helper;
 
   public CircularRevealRelativeLayout(Context context) {
     this(context, null);
@@ -80,7 +81,7 @@ public void setCircularRevealOverlayDrawable(@Nullable Drawable drawable) {
   }
 
   @Override
-  public void draw(Canvas canvas) {
+  public void draw(@NonNull Canvas canvas) {
     if (helper != null) {
       helper.draw(canvas);
     } else {

lib/java/com/google/android/material/circularreveal/CircularRevealWidget.java

@@ -19,6 +19,7 @@
 import android.graphics.Canvas;
 import android.graphics.drawable.Drawable;
 import androidx.annotation.ColorInt;
+import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 import android.util.Property;
 import android.view.View;
@@ -148,7 +149,7 @@ public RevealInfo(float centerX, float centerY, float radius) {
       this.radius = radius;
     }
 
-    public RevealInfo(RevealInfo other) {
+    public RevealInfo(@NonNull RevealInfo other) {
       this(other.centerX, other.centerY, other.radius);
     }
 
@@ -158,7 +159,7 @@ public void set(float centerX, float centerY, float radius) {
       this.radius = radius;
     }
 
-    public void set(RevealInfo other) {
+    public void set(@NonNull RevealInfo other) {
       set(other.centerX, other.centerY, other.radius);
     }
 
@@ -184,13 +185,14 @@ private CircularRevealProperty(String name) {
       super(RevealInfo.class, name);
     }
 
+    @Nullable
     @Override
-    public RevealInfo get(CircularRevealWidget object) {
+    public RevealInfo get(@NonNull CircularRevealWidget object) {
       return object.getRevealInfo();
     }
 
     @Override
-    public void set(CircularRevealWidget object, RevealInfo value) {
+    public void set(@NonNull CircularRevealWidget object, @Nullable RevealInfo value) {
       object.setRevealInfo(value);
     }
   }
@@ -207,8 +209,10 @@ class CircularRevealEvaluator implements TypeEvaluator<RevealInfo> {
     public static final TypeEvaluator<RevealInfo> CIRCULAR_REVEAL = new CircularRevealEvaluator();
     private final RevealInfo revealInfo = new RevealInfo();
 
+    @NonNull
     @Override
-    public RevealInfo evaluate(float fraction, RevealInfo startValue, RevealInfo endValue) {
+    public RevealInfo evaluate(
+        float fraction, @NonNull RevealInfo startValue, @NonNull RevealInfo endValue) {
       revealInfo.set(
           MathUtils.lerp(startValue.centerX, endValue.centerX, fraction),
           MathUtils.lerp(startValue.centerY, endValue.centerY, fraction),
@@ -230,13 +234,14 @@ private CircularRevealScrimColorProperty(String name) {
       super(Integer.class, name);
     }
 
+    @NonNull
     @Override
-    public Integer get(CircularRevealWidget object) {
+    public Integer get(@NonNull CircularRevealWidget object) {
       return object.getCircularRevealScrimColor();
     }
 
     @Override
-    public void set(CircularRevealWidget object, Integer value) {
+    public void set(@NonNull CircularRevealWidget object, @NonNull Integer value) {
       object.setCircularRevealScrimColor(value);
     }
   }