Make parameters/variables final where possible

yawnoc · yawnoc · commit 0f854f095b93 · 2021-07-09T01:31:53.000+08:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,7 @@
 - Reduced digit row key height
 - Added fillColour attribute for the keyboard as a whole
 - Lightened key fill and text colours slightly
+- Made parameters/variables final where possible
 
 
 ## [v0.3.0] Basic keyboard behaviour (2021-07-08)
diff --git a/app/src/main/java/io/github/yawnoc/strokeinput/InputContainer.java b/app/src/main/java/io/github/yawnoc/strokeinput/InputContainer.java
@@ -69,7 +69,7 @@ public class InputContainer
   private final Paint keyBorderPaint;
   private final Paint keyTextPaint;
   
-  public InputContainer(Context context, AttributeSet attributes) {
+  public InputContainer(final Context context, final AttributeSet attributes) {
     
     super(context, attributes);
     
@@ -126,27 +126,30 @@ public interface OnInputListener {
     void onLongPress(String valueText);
   }
   
-  public void setOnInputListener(OnInputListener listener) {
+  public void setOnInputListener(final OnInputListener listener) {
     inputListener = listener;
   }
   
-  public void setKeyboard(Keyboard keyboard) {
+  public void setKeyboard(final Keyboard keyboard) {
     this.keyboard = keyboard;
     keyArray = keyboard.getKeyList().toArray(new Keyboard.Key[0]);
     requestLayout();
   }
   
-  public void onClick(View view) {
+  public void onClick(final View view) {
   }
   
   @Override
-  public void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {
-    
-    int paddingHorizontal = getPaddingLeft() + getPaddingRight();
-    int paddingVertical = getPaddingTop() + getPaddingBottom();
+  public void onMeasure(
+    final int widthMeasureSpec,
+    final int heightMeasureSpec
+  )
+  {
+    final int paddingHorizontal = getPaddingLeft() + getPaddingRight();
+    final int paddingVertical = getPaddingTop() + getPaddingBottom();
     
-    int keyboardWidth;
-    int keyboardHeight;
+    final int keyboardWidth;
+    final int keyboardHeight;
     if (keyboard == null) {
       keyboardWidth = 0;
       keyboardHeight = 0;
@@ -163,7 +166,7 @@ public void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {
   }
   
   @Override
-  public void onDraw(Canvas canvas) {
+  public void onDraw(final Canvas canvas) {
     
     if (keyboard == null) {
       return;
@@ -187,11 +190,11 @@ public void onDraw(Canvas canvas) {
       keyTextPaint.setColor(key.keyTextColour);
       keyTextPaint.setTextSize(key.keyTextSize);
       
-      float key_text_x = (
+      final float key_text_x = (
         key.width / 2f
           + key.keyTextOffsetX
       );
-      float key_text_y = (
+      final float key_text_y = (
         (key.height - keyTextPaint.ascent() - keyTextPaint.descent()) / 2f
           + key.keyTextOffsetY
       );
@@ -216,9 +219,9 @@ public void onDraw(Canvas canvas) {
     Lighten a dark colour and darken a light colour.
     Used for key press colour changes.
   */
-  private static int getContrastingColour(int colour) {
+  private static int getContrastingColour(final int colour) {
     
-    float[] colourHSL = new float[3];
+    final float[] colourHSL = new float[3];
     ColorUtils.colorToHSL(colour, colourHSL);
     
     float colourLightness = colourHSL[2];
@@ -240,21 +243,21 @@ Handle logic for multiple pointers (e.g. two-thumb typing).
   */
   @SuppressLint("ClickableViewAccessibility")
   @Override
-  public boolean onTouchEvent(MotionEvent motionEvent) {
+  public boolean onTouchEvent(final MotionEvent motionEvent) {
     
     if (motionEvent.getPointerCount() > 2) {
       abortAllKeyBehaviour();
       return true;
     }
     
-    long eventTime = motionEvent.getEventTime();
-    int eventAction = motionEvent.getActionMasked();
-    int eventActionIndex = motionEvent.getActionIndex();
-    int eventPointerId = motionEvent.getPointerId(eventActionIndex);
-    int eventPointerIndex = motionEvent.findPointerIndex(eventPointerId);
-    int eventPointerX = (int) motionEvent.getX(eventPointerIndex);
-    int eventPointerY = (int) motionEvent.getY(eventPointerIndex);
-    int eventMetaState = motionEvent.getMetaState();
+    final long eventTime = motionEvent.getEventTime();
+    final int eventAction = motionEvent.getActionMasked();
+    final int eventActionIndex = motionEvent.getActionIndex();
+    final int eventPointerId = motionEvent.getPointerId(eventActionIndex);
+    final int eventPointerIndex = motionEvent.findPointerIndex(eventPointerId);
+    final int eventPointerX = (int) motionEvent.getX(eventPointerIndex);
+    final int eventPointerY = (int) motionEvent.getY(eventPointerIndex);
+    final int eventMetaState = motionEvent.getMetaState();
     
     boolean eventHandled = true;
     
@@ -337,32 +340,32 @@ public boolean onTouchEvent(MotionEvent motionEvent) {
   }
   
   private boolean sendSinglePointerMotionEvent(
-    long time,
-    int action,
-    int x,
-    int y,
-    int metaState
+    final long time,
+    final int action,
+    final int x,
+    final int y,
+    final int metaState
   )
   {
-    MotionEvent sentEvent =
+    final MotionEvent sentEvent =
       MotionEvent.obtain(time, time, action, x, y, metaState);
     
     return onSinglePointerTouchEvent(sentEvent);
   }
   
-  private boolean onSinglePointerTouchEvent(MotionEvent motionEvent) {
+  private boolean onSinglePointerTouchEvent(final MotionEvent motionEvent) {
     
-    int eventX = (int) motionEvent.getX() - getPaddingLeft();
-    int eventY = (int) motionEvent.getY() - getPaddingTop();
+    final int eventX = (int) motionEvent.getX() - getPaddingLeft();
+    final int eventY = (int) motionEvent.getY() - getPaddingTop();
     
-    Keyboard.Key key = getKeyAtPoint(eventX, eventY);
+    final Keyboard.Key key = getKeyAtPoint(eventX, eventY);
     if (key == null) {
       abortAllKeyBehaviour();
       return true;
     }
-    String valueText = key.valueText;
+    final String valueText = key.valueText;
     
-    int eventAction = motionEvent.getAction();
+    final int eventAction = motionEvent.getAction();
     
     switch (eventAction) {
       
@@ -387,9 +390,9 @@ private boolean onSinglePointerTouchEvent(MotionEvent motionEvent) {
     return true;
   }
   
-  private Keyboard.Key getKeyAtPoint(int x, int y) {
+  private Keyboard.Key getKeyAtPoint(final int x, final int y) {
     
-    for (Keyboard.Key key : keyArray) {
+    for (final Keyboard.Key key : keyArray) {
       if (key.containsPoint(x, y)) {
         return key;
       }
@@ -398,12 +401,15 @@ private Keyboard.Key getKeyAtPoint(int x, int y) {
     return null;
   }
   
-  private void setCurrentlyPressedKey(Keyboard.Key key) {
+  private void setCurrentlyPressedKey(final Keyboard.Key key) {
     currentlyPressedKey = key;
     invalidate();
   }
   
-  private void sendAppropriateExtendedPressHandlerMessage(Keyboard.Key key) {
+  private void sendAppropriateExtendedPressHandlerMessage(
+    final Keyboard.Key key
+  )
+  {
     if (key.isRepeatable) {
       sendExtendedPressHandlerMessage(
         MESSAGE_KEY_REPEAT,
@@ -419,8 +425,8 @@ else if (key.isLongPressable) {
   }
   
   private void sendExtendedPressHandlerMessage(
-    int messageWhat,
-    long delayMilliseconds
+    final int messageWhat,
+    final long delayMilliseconds
   )
   {
     extendedPressHandler.sendMessageDelayed(
@@ -434,7 +440,7 @@ private void removeAllExtendedPressHandlerMessages() {
     removeExtendedPressHandlerMessages(MESSAGE_LONG_PRESS);
   }
   
-  private void removeExtendedPressHandlerMessages(int messageWhat) {
+  private void removeExtendedPressHandlerMessages(final int messageWhat) {
     extendedPressHandler.removeMessages(messageWhat);
   }
   
diff --git a/app/src/main/java/io/github/yawnoc/strokeinput/Keyboard.java b/app/src/main/java/io/github/yawnoc/strokeinput/Keyboard.java
@@ -66,9 +66,10 @@ public class Keyboard {
   private final int screenWidth;
   private final int screenHeight;
   
-  public Keyboard(Context context, int layoutResourceId) {
+  public Keyboard(final Context context, final int layoutResourceId) {
     
-    DisplayMetrics displayMetrics = context.getResources().getDisplayMetrics();
+    final DisplayMetrics displayMetrics =
+      context.getResources().getDisplayMetrics();
     
     screenWidth = displayMetrics.widthPixels;
     screenHeight = displayMetrics.heightPixels;
@@ -109,14 +110,14 @@ public static class Row {
     private final Keyboard parentKeyboard;
     
     public Row(
-      Keyboard parentKeyboard,
-      Resources resources,
-      XmlResourceParser xmlResourceParser
+      final Keyboard parentKeyboard,
+      final Resources resources,
+      final XmlResourceParser xmlResourceParser
     )
     {
       this.parentKeyboard = parentKeyboard;
       
-      TypedArray attributesArray =
+      final TypedArray attributesArray =
         resources.obtainAttributes(
           Xml.asAttributeSet(xmlResourceParser),
           R.styleable.Keyboard
@@ -211,26 +212,26 @@ public static class Key {
     // Key meta-properties
     private final Keyboard grandparentKeyboard;
     
-    public Key(Row parentRow) {
+    public Key(final Row parentRow) {
       grandparentKeyboard = parentRow.parentKeyboard;
       width = parentRow.keyWidth;
       height = parentRow.keyHeight;
     }
     
     public Key(
-      Row parentRow,
-      int x,
-      int y,
-      Resources resources,
-      XmlResourceParser xmlResourceParser
+      final Row parentRow,
+      final int x,
+      final int y,
+      final Resources resources,
+      final XmlResourceParser xmlResourceParser
     )
     {
       this(parentRow);
       
       this.x = x;
       this.y = y;
       
-      TypedArray attributesArray =
+      final TypedArray attributesArray =
         resources.obtainAttributes(
           Xml.asAttributeSet(xmlResourceParser),
           R.styleable.Keyboard
@@ -304,7 +305,7 @@ public Key(
       attributesArray.recycle();
     }
     
-    public boolean containsPoint(int x, int y) {
+    public boolean containsPoint(final int x, final int y) {
       return (
         this.x <= x && x <= this.x + this.width
           &&
@@ -322,8 +323,8 @@ public int getHeight() {
   }
   
   private void loadKeyboard(
-    Context context,
-    XmlResourceParser xmlResourceParser
+    final Context context,
+    final XmlResourceParser xmlResourceParser
   )
   {
     try {
@@ -339,7 +340,7 @@ private void loadKeyboard(
       int maximumX = x;
       int maximumY = y;
       
-      Resources resources = context.getResources();
+      final Resources resources = context.getResources();
       
       int event;
       
@@ -349,7 +350,7 @@ private void loadKeyboard(
       {
         switch (event) {
           case XmlResourceParser.START_TAG:
-            String xmlTag = xmlResourceParser.getName();
+            final String xmlTag = xmlResourceParser.getName();
             switch (xmlTag) {
               case "Keyboard":
                 parseKeyboardAttributes(resources, xmlResourceParser);
@@ -392,11 +393,11 @@ else if (inRow) {
   }
   
   private void parseKeyboardAttributes(
-    Resources resources,
-    XmlResourceParser xmlResourceParser
+    final Resources resources,
+    final XmlResourceParser xmlResourceParser
   )
   {
-    TypedArray attributesArray =
+    final TypedArray attributesArray =
       resources.obtainAttributes(
         Xml.asAttributeSet(xmlResourceParser),
         R.styleable.Keyboard
@@ -465,13 +466,13 @@ private void parseKeyboardAttributes(
   }
   
   private static int getDimensionOrFraction(
-    TypedArray array,
-    int attributeIndex,
-    int baseValue,
-    int defaultValue
+    final TypedArray array,
+    final int attributeIndex,
+    final int baseValue,
+    final int defaultValue
   )
   {
-    TypedValue value = array.peekValue(attributeIndex);
+    final TypedValue value = array.peekValue(attributeIndex);
     if (value == null) {
       return defaultValue;
     }
diff --git a/app/src/main/java/io/github/yawnoc/strokeinput/MainActivity.java b/app/src/main/java/io/github/yawnoc/strokeinput/MainActivity.java
@@ -32,30 +32,32 @@ public class MainActivity
   implements View.OnClickListener
 {
   @Override
-  protected void onCreate(Bundle savedInstanceState) {
+  protected void onCreate(final Bundle savedInstanceState) {
     
     super.onCreate(savedInstanceState);
     setContentView(R.layout.activity_main);
     
-    Button inputSettingsButton = findViewById(R.id.input_settings_button);
+    final Button inputSettingsButton =
+      findViewById(R.id.input_settings_button);
     inputSettingsButton.setOnClickListener(this);
     
-    Button switchKeyboardButton = findViewById(R.id.switch_keyboard_button);
+    final Button switchKeyboardButton =
+      findViewById(R.id.switch_keyboard_button);
     switchKeyboardButton.setOnClickListener(this);
     
   }
   
   @Override
-  public void onClick(View view) {
+  public void onClick(final View view) {
     
-    int viewId = view.getId();
+    final int viewId = view.getId();
     
     if (viewId == R.id.input_settings_button) {
       Intent intent = new Intent(Settings.ACTION_INPUT_METHOD_SETTINGS);
       startActivity(intent);
     }
     else if (viewId == R.id.switch_keyboard_button) {
-      InputMethodManager inputMethodManager =
+      final InputMethodManager inputMethodManager =
         (InputMethodManager) getSystemService(INPUT_METHOD_SERVICE);
       inputMethodManager.showInputMethodPicker();
     }
diff --git a/app/src/main/java/io/github/yawnoc/strokeinput/StrokeInputService.java b/app/src/main/java/io/github/yawnoc/strokeinput/StrokeInputService.java
