Add @nonnull and @nullable annotations

cketcham · afohrman · commit 0ad01010b942 · 2019-09-04T18:03:53.000-04:00
PiperOrigin-RevId: 266817244
diff --git a/lib/java/com/google/android/material/floatingactionbutton/BaseMotionStrategy.java b/lib/java/com/google/android/material/floatingactionbutton/BaseMotionStrategy.java
@@ -34,14 +34,14 @@
 abstract class BaseMotionStrategy implements MotionStrategy {
 
   private final Context context;
-  private final ExtendedFloatingActionButton fab;
+  @NonNull private final ExtendedFloatingActionButton fab;
   private final ArrayList<AnimatorListener> listeners = new ArrayList<>();
   private final AnimatorTracker tracker;
 
   @Nullable private MotionSpec defaultMotionSpec;
   @Nullable private MotionSpec motionSpec;
 
-  BaseMotionStrategy(ExtendedFloatingActionButton fab, AnimatorTracker tracker) {
+  BaseMotionStrategy(@NonNull ExtendedFloatingActionButton fab, AnimatorTracker tracker) {
     this.fab = fab;
     this.context = fab.getContext();
     this.tracker = tracker;
@@ -78,6 +78,7 @@ public final void removeAnimationListener(@NonNull AnimatorListener listener) {
     listeners.remove(listener);
   }
 
+  @NonNull
   @Override
   public final List<AnimatorListener> getListeners() {
     return listeners;
@@ -112,6 +113,7 @@ public AnimatorSet createAnimator() {
     return createAnimator(getCurrentMotionSpec());
   }
 
+  @NonNull
   AnimatorSet createAnimator(@NonNull MotionSpec spec) {
     List<Animator> animators = new ArrayList<>();
 
diff --git a/lib/java/com/google/android/material/floatingactionbutton/BorderDrawable.java b/lib/java/com/google/android/material/floatingactionbutton/BorderDrawable.java
@@ -59,7 +59,7 @@ class BorderDrawable extends Drawable {
 
   private final ShapeAppearancePathProvider pathProvider = new ShapeAppearancePathProvider();
 
-  private final Paint paint;
+  @NonNull private final Paint paint;
   private final Path shapePath = new Path();
   private final Rect rect = new Rect();
   private final RectF rectF = new RectF();
@@ -119,7 +119,7 @@ void setGradientColors(
   }
 
   @Override
-  public void draw(Canvas canvas) {
+  public void draw(@NonNull Canvas canvas) {
     if (invalidateShader) {
       paint.setShader(createGradientShader());
       invalidateShader = false;
@@ -157,7 +157,7 @@ public void getOutline(@NonNull Outline outline) {
   }
 
   @Override
-  public boolean getPadding(Rect padding) {
+  public boolean getPadding(@NonNull Rect padding) {
     if (shapeAppearanceModel.isRoundRect()) {
       final int borderWidth = Math.round(this.borderWidth);
       padding.set(borderWidth, borderWidth, borderWidth, borderWidth);
@@ -210,6 +210,7 @@ protected boolean onStateChange(int[] state) {
     return invalidateShader;
   }
 
+  @NonNull
   private Shader createGradientShader() {
     final Rect rect = this.rect;
     copyBounds(rect);
diff --git a/lib/java/com/google/android/material/floatingactionbutton/ExtendedFloatingActionButton.java b/lib/java/com/google/android/material/floatingactionbutton/ExtendedFloatingActionButton.java
@@ -79,12 +79,12 @@ public class ExtendedFloatingActionButton extends MaterialButton implements Atta
   private int animState = ANIM_STATE_NONE;
 
   private final AnimatorTracker changeVisibilityTracker = new AnimatorTracker();
-  private final MotionStrategy shrinkStrategy;
-  private final MotionStrategy extendStrategy;
+  @NonNull private final MotionStrategy shrinkStrategy;
+  @NonNull private final MotionStrategy extendStrategy;
   private final MotionStrategy showStrategy = new ShowStrategy(changeVisibilityTracker);
   private final MotionStrategy hideStrategy = new HideStrategy(changeVisibilityTracker);
 
-  private final Behavior<ExtendedFloatingActionButton> behavior;
+  @NonNull private final Behavior<ExtendedFloatingActionButton> behavior;
 
   private boolean isExtended = true;
   private boolean isUsingPillCorner = true;
@@ -137,17 +137,17 @@ public void onExtended(ExtendedFloatingActionButton extendedFab) {}
     public void onShrunken(ExtendedFloatingActionButton extendedFab) {}
   }
 
-  public ExtendedFloatingActionButton(Context context) {
+  public ExtendedFloatingActionButton(@NonNull Context context) {
     this(context, null);
   }
 
-  public ExtendedFloatingActionButton(Context context, @Nullable AttributeSet attrs) {
+  public ExtendedFloatingActionButton(@NonNull Context context, @Nullable AttributeSet attrs) {
     this(context, attrs, R.attr.extendedFloatingActionButtonStyle);
   }
 
   @SuppressWarnings("initialization")
   public ExtendedFloatingActionButton(
-      Context context, @Nullable AttributeSet attrs, int defStyleAttr) {
+      @NonNull Context context, @Nullable AttributeSet attrs, int defStyleAttr) {
     super(context, attrs, defStyleAttr);
     behavior = new ExtendedFloatingActionButtonBehavior<>(context, attrs);
     TypedArray a =
@@ -565,7 +565,7 @@ boolean isUsingPillCorner() {
   }
 
   private void performMotion(
-      final MotionStrategy strategy, @Nullable final OnChangedCallback callback) {
+      @NonNull final MotionStrategy strategy, @Nullable final OnChangedCallback callback) {
     if (strategy.shouldCancel()) {
       return;
     }
@@ -639,16 +639,17 @@ private boolean shouldAnimateVisibilityChange() {
    * A Property wrapper around the <code>width</code> functionality handled by the {@link
    * LayoutParams#width} value.
    */
-   static final Property<View, Float> WIDTH =
+  static final Property<View, Float> WIDTH =
       new Property<View, Float>(Float.class, "width") {
         @Override
-        public void set(View object, Float value) {
+        public void set(@NonNull View object, @NonNull Float value) {
           object.getLayoutParams().width = value.intValue();
           object.requestLayout();
         }
 
+        @NonNull
         @Override
-        public Float get(View object) {
+        public Float get(@NonNull View object) {
           return (float) object.getLayoutParams().width;
         }
       };
@@ -657,16 +658,17 @@ public Float get(View object) {
    * A Property wrapper around the <code>height</code> functionality handled by the {@link
    * LayoutParams#height} value.
    */
-   static final Property<View, Float> HEIGHT =
+  static final Property<View, Float> HEIGHT =
       new Property<View, Float>(Float.class, "height") {
         @Override
-        public void set(View object, Float value) {
+        public void set(@NonNull View object, @NonNull Float value) {
           object.getLayoutParams().height = value.intValue();
           object.requestLayout();
         }
 
+        @NonNull
         @Override
-        public Float get(View object) {
+        public Float get(@NonNull View object) {
           return (float) object.getLayoutParams().height;
         }
       };
@@ -679,14 +681,14 @@ public Float get(View object) {
   static final Property<View, Float> CORNER_RADIUS =
       new Property<View, Float>(Float.class, "cornerRadius") {
         @Override
-        public void set(View object, Float value) {
+        public void set(@NonNull View object, @NonNull Float value) {
           ExtendedFloatingActionButton efab = ((ExtendedFloatingActionButton) object);
           efab.setShapeAppearanceModel(
               efab.getShapeAppearanceModel().withCornerRadius(value.intValue()));
         }
 
         @Override
-        public Float get(View object) {
+        public Float get(@NonNull View object) {
           return ((ExtendedFloatingActionButton) object)
               .getShapeAppearanceModel()
               .getTopRightCorner()
@@ -738,7 +740,8 @@ public ExtendedFloatingActionButtonBehavior() {
 
     // Behavior attrs should be nullable in the framework
     @SuppressWarnings("argument.type.incompatible")
-    public ExtendedFloatingActionButtonBehavior(Context context, @Nullable AttributeSet attrs) {
+    public ExtendedFloatingActionButtonBehavior(
+        @NonNull Context context, @Nullable AttributeSet attrs) {
       super(context, attrs);
       TypedArray a =
           context.obtainStyledAttributes(
@@ -817,7 +820,7 @@ public void onAttachedToLayoutParams(@NonNull CoordinatorLayout.LayoutParams lp)
 
     @Override
     public boolean onDependentViewChanged(
-        CoordinatorLayout parent, ExtendedFloatingActionButton child, View dependency) {
+        CoordinatorLayout parent, @NonNull ExtendedFloatingActionButton child, View dependency) {
       if (dependency instanceof AppBarLayout) {
         // If we're depending on an AppBarLayout we will show/hide it automatically
         // if the FAB is anchored to the AppBarLayout
@@ -846,7 +849,8 @@ void setInternalAutoShrinkCallback(@Nullable OnChangedCallback callback) {
       internalAutoShrinkCallback = callback;
     }
 
-    private boolean shouldUpdateVisibility(View dependency, ExtendedFloatingActionButton child) {
+    private boolean shouldUpdateVisibility(
+        @NonNull View dependency, @NonNull ExtendedFloatingActionButton child) {
       final CoordinatorLayout.LayoutParams lp =
           (CoordinatorLayout.LayoutParams) child.getLayoutParams();
       if (!autoHideEnabled && !autoShrinkEnabled) {
@@ -863,7 +867,9 @@ private boolean shouldUpdateVisibility(View dependency, ExtendedFloatingActionBu
     }
 
     private boolean updateFabVisibilityForAppBarLayout(
-        CoordinatorLayout parent, AppBarLayout appBarLayout, ExtendedFloatingActionButton child) {
+        CoordinatorLayout parent,
+        @NonNull AppBarLayout appBarLayout,
+        @NonNull ExtendedFloatingActionButton child) {
       if (!shouldUpdateVisibility(appBarLayout, child)) {
         return false;
       }
@@ -887,7 +893,7 @@ private boolean updateFabVisibilityForAppBarLayout(
     }
 
     private boolean updateFabVisibilityForBottomSheet(
-        View bottomSheet, ExtendedFloatingActionButton child) {
+        @NonNull View bottomSheet, @NonNull ExtendedFloatingActionButton child) {
       if (!shouldUpdateVisibility(bottomSheet, child)) {
         return false;
       }
@@ -948,7 +954,9 @@ protected void extendOrShow(@NonNull ExtendedFloatingActionButton fab) {
 
     @Override
     public boolean onLayoutChild(
-        CoordinatorLayout parent, ExtendedFloatingActionButton child, int layoutDirection) {
+        @NonNull CoordinatorLayout parent,
+        @NonNull ExtendedFloatingActionButton child,
+        int layoutDirection) {
       // First, let's make sure that the visibility of the FAB is consistent
       final List<View> dependencies = parent.getDependencies(child);
       for (int i = 0, count = dependencies.size(); i < count; i++) {
@@ -991,7 +999,8 @@ public boolean getInsetDodgeRect(
      * offsets our layout position so that we're positioned correctly if we're on one of our
      * parent's edges.
      */
-    private void offsetIfNeeded(CoordinatorLayout parent, ExtendedFloatingActionButton fab) {
+    private void offsetIfNeeded(
+        @NonNull CoordinatorLayout parent, @NonNull ExtendedFloatingActionButton fab) {
       final Rect padding = fab.shadowPadding;
 
       if (padding != null && padding.centerX() > 0 && padding.centerY() > 0) {
@@ -1077,6 +1086,7 @@ public int getDefaultMotionSpecResource() {
       return R.animator.mtrl_extended_fab_change_size_motion_spec;
     }
 
+    @NonNull
     @Override
     public AnimatorSet createAnimator() {
       MotionSpec spec = getCurrentMotionSpec();
diff --git a/lib/java/com/google/android/material/floatingactionbutton/FloatingActionButton.java b/lib/java/com/google/android/material/floatingactionbutton/FloatingActionButton.java
@@ -184,21 +184,22 @@ public void onHidden(FloatingActionButton fab) {}
   final Rect shadowPadding = new Rect();
   private final Rect touchArea = new Rect();
 
-  private final AppCompatImageHelper imageHelper;
-  private final ExpandableWidgetHelper expandableWidgetHelper;
+  @NonNull private final AppCompatImageHelper imageHelper;
+  @NonNull private final ExpandableWidgetHelper expandableWidgetHelper;
 
   private FloatingActionButtonImpl impl;
 
-  public FloatingActionButton(Context context) {
+  public FloatingActionButton(@NonNull Context context) {
     this(context, null);
   }
 
-  public FloatingActionButton(Context context, @Nullable AttributeSet attrs) {
+  public FloatingActionButton(@NonNull Context context, @Nullable AttributeSet attrs) {
     this(context, attrs, R.attr.floatingActionButtonStyle);
   }
 
   @SuppressWarnings("initialization")
-  public FloatingActionButton(Context context, @Nullable AttributeSet attrs, int defStyleAttr) {
+  public FloatingActionButton(
+      @NonNull Context context, @Nullable AttributeSet attrs, int defStyleAttr) {
     super(createThemedContext(context, attrs, defStyleAttr, DEF_STYLE_RES), attrs, defStyleAttr);
     // Ensure we are using the correctly themed context rather than the context that was passed in.
     context = getContext();
@@ -512,7 +513,7 @@ public void setImageDrawable(@Nullable Drawable drawable) {
   }
 
   /** Sets the {@link ShapeAppearanceModel} for this {@link FloatingActionButton}. */
-  public void setShapeAppearance(ShapeAppearanceModel shapeAppearance) {
+  public void setShapeAppearance(@NonNull ShapeAppearanceModel shapeAppearance) {
     getImpl().setShapeAppearance(shapeAppearance, isUsingDefaultCorner(shapeAppearance));
   }
 
@@ -914,7 +915,7 @@ private static int resolveAdjustedSize(int desiredSize, int measureSpec) {
   }
 
   @Override
-  public boolean onTouchEvent(MotionEvent ev) {
+  public boolean onTouchEvent(@NonNull MotionEvent ev) {
     if (ev.getAction() == MotionEvent.ACTION_DOWN) {
       // Skipping the gesture if it doesn't start in the FAB 'content' area
       if (getContentRect(touchArea) && !touchArea.contains((int) ev.getX(), (int) ev.getY())) {
@@ -1006,7 +1007,7 @@ public void onAttachedToLayoutParams(@NonNull CoordinatorLayout.LayoutParams lp)
 
     @Override
     public boolean onDependentViewChanged(
-        CoordinatorLayout parent, FloatingActionButton child, View dependency) {
+        CoordinatorLayout parent, @NonNull FloatingActionButton child, View dependency) {
       if (dependency instanceof AppBarLayout) {
         // If we're depending on an AppBarLayout we will show/hide it automatically
         // if the FAB is anchored to the AppBarLayout
@@ -1030,7 +1031,8 @@ public void setInternalAutoHideListener(OnVisibilityChangedListener listener) {
       internalAutoHideListener = listener;
     }
 
-    private boolean shouldUpdateVisibility(View dependency, FloatingActionButton child) {
+    private boolean shouldUpdateVisibility(
+        @NonNull View dependency, @NonNull FloatingActionButton child) {
       final CoordinatorLayout.LayoutParams lp =
           (CoordinatorLayout.LayoutParams) child.getLayoutParams();
       if (!autoHideEnabled) {
@@ -1053,7 +1055,9 @@ private boolean shouldUpdateVisibility(View dependency, FloatingActionButton chi
     }
 
     private boolean updateFabVisibilityForAppBarLayout(
-        CoordinatorLayout parent, AppBarLayout appBarLayout, FloatingActionButton child) {
+        CoordinatorLayout parent,
+        @NonNull AppBarLayout appBarLayout,
+        @NonNull FloatingActionButton child) {
       if (!shouldUpdateVisibility(appBarLayout, child)) {
         return false;
       }
@@ -1077,7 +1081,7 @@ private boolean updateFabVisibilityForAppBarLayout(
     }
 
     private boolean updateFabVisibilityForBottomSheet(
-        View bottomSheet, FloatingActionButton child) {
+        @NonNull View bottomSheet, @NonNull FloatingActionButton child) {
       if (!shouldUpdateVisibility(bottomSheet, child)) {
         return false;
       }
@@ -1092,7 +1096,9 @@ private boolean updateFabVisibilityForBottomSheet(
 
     @Override
     public boolean onLayoutChild(
-        CoordinatorLayout parent, FloatingActionButton child, int layoutDirection) {
+        @NonNull CoordinatorLayout parent,
+        @NonNull FloatingActionButton child,
+        int layoutDirection) {
       // First, let's make sure that the visibility of the FAB is consistent
       final List<View> dependencies = parent.getDependencies(child);
       for (int i = 0, count = dependencies.size(); i < count; i++) {
@@ -1135,7 +1141,8 @@ public boolean getInsetDodgeRect(
      * offsets our layout position so that we're positioned correctly if we're on one of our
      * parent's edges.
      */
-    private void offsetIfNeeded(CoordinatorLayout parent, FloatingActionButton fab) {
+    private void offsetIfNeeded(
+        @NonNull CoordinatorLayout parent, @NonNull FloatingActionButton fab) {
       final Rect padding = fab.shadowPadding;
 
       if (padding != null && padding.centerX() > 0 && padding.centerY() > 0) {
@@ -1345,7 +1352,7 @@ public void removeTransformationCallback(
     getImpl().removeTransformationCallback(new TransformationCallbackWrapper(listener));
   }
 
-  private boolean isUsingDefaultCorner(ShapeAppearanceModel shapeAppearance) {
+  private boolean isUsingDefaultCorner(@NonNull ShapeAppearanceModel shapeAppearance) {
     return shapeAppearance.getTopRightCorner().getCornerSize() == -1;
   }
 
@@ -1428,6 +1435,7 @@ private FloatingActionButtonImpl getImpl() {
     return impl;
   }
 
+  @NonNull
   private FloatingActionButtonImpl createImpl() {
     if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP) {
       return new FloatingActionButtonImplLollipop(this, new ShadowDelegateImpl());
diff --git a/lib/java/com/google/android/material/floatingactionbutton/FloatingActionButtonImpl.java b/lib/java/com/google/android/material/floatingactionbutton/FloatingActionButtonImpl.java
diff --git a/lib/java/com/google/android/material/floatingactionbutton/FloatingActionButtonImplLollipop.java b/lib/java/com/google/android/material/floatingactionbutton/FloatingActionButtonImplLollipop.java
