NFC Library Update

- Move the BaseNfcListenerFragment to the basicnfclibrary - Create BaseActivityWithNfcListeners class for activities that need to dispatch nfc tags discovered to listeners - Create function to register and unregister nfc tag discovered listeners in the activity
OganBelema · May 7, 2019 · 5476e3f · 5476e3f
1 parent 60342a5
commit 5476e3f
Show file tree

Hide file tree

Showing 9 changed files with 79 additions and 37 deletions.
diff --git a/app/src/main/java/com/oganbelema/nfcforecommerce/admin/addcustomer/AddCustomerFragment.kt b/app/src/main/java/com/oganbelema/nfcforecommerce/admin/addcustomer/AddCustomerFragment.kt
@@ -8,7 +8,7 @@ import android.view.ViewGroup
 import com.google.android.material.snackbar.Snackbar
 
 import com.oganbelema.nfcforecommerce.R
-import com.oganbelema.nfcforecommerce.base.BaseNfcListenerFragment
+import com.oganbelema.basicnfclibrary.BaseNfcListenerFragment
 import com.oganbelema.nfcforecommerce.util.Util
 import kotlinx.android.synthetic.main.add_customer_fragment.*
 

diff --git a/app/src/main/java/com/oganbelema/nfcforecommerce/base/BaseActivity.kt b/app/src/main/java/com/oganbelema/nfcforecommerce/base/BaseActivity.kt
@@ -1,13 +1,12 @@
 package com.oganbelema.nfcforecommerce.base
 
-import android.content.Intent
-import androidx.appcompat.app.AppCompatActivity
 import android.os.Bundle
 import android.widget.Toast
 import androidx.navigation.NavController
 import androidx.navigation.findNavController
 import androidx.navigation.ui.setupActionBarWithNavController
 import androidx.navigation.ui.setupWithNavController
+import com.oganbelema.basicnfclibrary.BaseActivityWithNfcListeners
 import com.oganbelema.basicnfclibrary.NFCRegistration
 import com.oganbelema.nfcforecommerce.R
 import kotlinx.android.synthetic.main.activity_base.*
@@ -16,7 +15,7 @@ import kotlinx.android.synthetic.main.activity_base.*
 /**
  * This base activity for the application that will serve as the entry point to the app
  */
-class BaseActivity : AppCompatActivity() {
+class BaseActivity : BaseActivityWithNfcListeners() {
 
     /**
      * This is the device's default nfc adapter
@@ -33,11 +32,7 @@ class BaseActivity : AppCompatActivity() {
      */
     private lateinit var navController: NavController
 
-    /**
-     * Stores the listeners for when an nfc tag is discovered by the device and the
-     * BaseActivity is called
-     */
-    val nfcTagDiscoveredListeners: MutableList<NfcTagDiscoveredListener> = arrayListOf()
+
 
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
@@ -70,13 +65,5 @@ class BaseActivity : AppCompatActivity() {
         nfcRegistration.disableForegroundDispatch()
     }
 
-    override fun onNewIntent(intent: Intent?) {
-        super.onNewIntent(intent)
-
-        for (nfcTagDiscoveredListener in nfcTagDiscoveredListeners){
-            nfcTagDiscoveredListener.onNfcTagDiscovered(intent)
-        }
-    }
-
 
 }
diff --git a/app/src/main/java/com/oganbelema/nfcforecommerce/cashier/CashierFragment.kt b/app/src/main/java/com/oganbelema/nfcforecommerce/cashier/CashierFragment.kt
@@ -7,7 +7,7 @@ import android.view.View
 import android.view.ViewGroup
 
 import com.oganbelema.nfcforecommerce.R
-import com.oganbelema.nfcforecommerce.base.BaseNfcListenerFragment
+import com.oganbelema.basicnfclibrary.BaseNfcListenerFragment
 
 class CashierFragment : BaseNfcListenerFragment() {
 

diff --git a/app/src/main/java/com/oganbelema/nfcforecommerce/customersupport/CustomerSupportFragment.kt b/app/src/main/java/com/oganbelema/nfcforecommerce/customersupport/CustomerSupportFragment.kt
@@ -8,7 +8,7 @@ import android.view.ViewGroup
 import com.google.android.material.snackbar.Snackbar
 
 import com.oganbelema.nfcforecommerce.R
-import com.oganbelema.nfcforecommerce.base.BaseNfcListenerFragment
+import com.oganbelema.basicnfclibrary.BaseNfcListenerFragment
 import com.oganbelema.nfcforecommerce.util.Util
 import kotlinx.android.synthetic.main.add_customer_fragment.scanNfcTagHintViews
 import kotlinx.android.synthetic.main.customer_support_fragment.*

diff --git a/basicnfclibrary/src/main/AndroidManifest.xml b/basicnfclibrary/src/main/AndroidManifest.xml
@@ -1,4 +1,11 @@
+<?xml version="1.0" encoding="utf-8"?>
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
     package="com.oganbelema.basicnfclibrary">
-    <uses-permission android:name="android.permission.NFC"/>
-</manifest>
+
+    <uses-permission android:name="android.permission.NFC" />
+
+    <application>
+        <activity android:name=".BaseActivityWithNfcListeners"/>
+    </application>
+
+</manifest>
diff --git a/basicnfclibrary/src/main/java/com/oganbelema/basicnfclibrary/BaseActivityWithNfcListeners.kt b/basicnfclibrary/src/main/java/com/oganbelema/basicnfclibrary/BaseActivityWithNfcListeners.kt
@@ -0,0 +1,46 @@
+package com.oganbelema.basicnfclibrary
+
+import android.content.Intent
+import androidx.appcompat.app.AppCompatActivity
+import android.os.Bundle
+
+open class BaseActivityWithNfcListeners : AppCompatActivity() {
+
+    /**
+     * Stores the listeners for when an nfc tag is discovered by the device and the
+     * BaseActivity is called
+     */
+    private val nfcTagDiscoveredListeners: MutableList<NfcTagDiscoveredListener> = arrayListOf()
+
+    /**
+    * Registers the listener to receive the detected tag from the activity
+     * @param nfcTagDiscoveredListener a listener for discovered nfc tag
+    */
+    fun registerTagDiscoveredListener(nfcTagDiscoveredListener: NfcTagDiscoveredListener) {
+        nfcTagDiscoveredListeners.add(nfcTagDiscoveredListener)
+    }
+
+    /**
+     * Unregisters the listener from receiving the detected tag from the activity
+     * @param nfcTagDiscoveredListener a listener for discovered nfc tag
+     */
+    fun unregisterTagDiscoveredListener(nfcTagDiscoveredListener: NfcTagDiscoveredListener){
+        nfcTagDiscoveredListeners.remove(nfcTagDiscoveredListener)
+    }
+
+    override fun onNewIntent(intent: Intent?) {
+        super.onNewIntent(intent)
+
+        notifyListenersOfDetectedTag(intent)
+    }
+
+    /**
+     * Notifies the listeners that the tag was detected
+     * @param intent containing the discovered tag
+     */
+    private fun notifyListenersOfDetectedTag(intent: Intent?) {
+        for (nfcTagDiscoveredListener in nfcTagDiscoveredListeners) {
+            nfcTagDiscoveredListener.onNfcTagDiscovered(intent)
+        }
+    }
+}
diff --git a/...ecommerce/base/BaseNfcListenerFragment.kt → ...asicnfclibrary/BaseNfcListenerFragment.kt b/...ecommerce/base/BaseNfcListenerFragment.kt → ...asicnfclibrary/BaseNfcListenerFragment.kt
@@ -1,16 +1,17 @@
-package com.oganbelema.nfcforecommerce.base
+package com.oganbelema.basicnfclibrary
 
 import android.content.Intent
 import android.nfc.NfcAdapter
 import android.nfc.Tag
 import androidx.fragment.app.Fragment
+import com.oganbelema.basicnfclibrary.BaseActivityWithNfcListeners
+import com.oganbelema.basicnfclibrary.NfcTagDiscoveredListener
 
 
 /**
- * A base fragment that listens for nfc tag discovered notifications from the base
- * activity.
+ * A base fragment that listens for nfc tag discovered notifications from a BaseActivityWithNfcListeners.
  * Contains helper methods that are required by an nfc listener fragment
- * Extend this to listen for nfc tag discovered notifications from the base activity in a fragment
+ * Extend this to listen for nfc tag discovered notifications from a BaseActivityWithNfcListeners activity in a fragment
  */
 abstract class BaseNfcListenerFragment : Fragment(), NfcTagDiscoveredListener {
 
@@ -45,31 +46,30 @@ abstract class BaseNfcListenerFragment : Fragment(), NfcTagDiscoveredListener {
     abstract fun onExtractTagId(tagId: ByteArray?)
 
     /**
-     * Registers the fragment to receive the detected tag from the activity
+     * Registers the fragment as a listener for dispatched nfc tag discovered intent
      */
-    private fun registerTagDiscoveredListener() {
-        if (activity != null){
-            (activity as BaseActivity).nfcTagDiscoveredListeners.add(this)
+    private fun registerAsListener() {
+        if (activity != null) {
+            (activity as BaseActivityWithNfcListeners).registerTagDiscoveredListener(this)
         }
     }
 
     /**
-     * Unregisters the fragment from receiving the detected tag from the activity
+     * Unregisters the fragment as a listener for dispatched nfc tag discovered intent
      */
-    private fun unregisterTagDiscoveredListener(){
-        if (activity != null){
-            (activity as BaseActivity).nfcTagDiscoveredListeners.remove(this)
+    private fun unregisterAsListener() {
+        if (activity != null) {
+            (activity as BaseActivityWithNfcListeners).unregisterTagDiscoveredListener(this)
         }
     }
 
     override fun onStart() {
         super.onStart()
-        registerTagDiscoveredListener()
+        registerAsListener()
     }
 
     override fun onStop() {
-        unregisterTagDiscoveredListener()
+        unregisterAsListener()
         super.onStop()
     }
-
 }
diff --git a/basicnfclibrary/src/main/java/com/oganbelema/basicnfclibrary/NFCRegistration.kt b/basicnfclibrary/src/main/java/com/oganbelema/basicnfclibrary/NFCRegistration.kt
@@ -9,6 +9,7 @@ import android.nfc.NfcAdapter
 /**
  * Use this class to register to detect nfc tags in an activity
  * @param activity to be notified when nfc tag is discovered
+ * @author Belema Ogan
  */
 class NFCRegistration(private val activity: Activity) {
 

diff --git a/...commerce/base/NfcTagDiscoveredListener.kt → ...sicnfclibrary/NfcTagDiscoveredListener.kt b/...commerce/base/NfcTagDiscoveredListener.kt → ...sicnfclibrary/NfcTagDiscoveredListener.kt
@@ -1,9 +1,10 @@
-package com.oganbelema.nfcforecommerce.base
+package com.oganbelema.basicnfclibrary
 
 import android.content.Intent
 
 /**
  * Implement this to be able to receive nfc tag intent from the BaseActivity's onNewIntent
+ * @author Belema Ogan
  */
 interface NfcTagDiscoveredListener {