refactor(*): backStackIdentifier and targetFragmentId

Author: chetan-fueled

flowr/src/main/java/com/fueled/flowr/Flowr.java

@@ -56,7 +56,6 @@ public class Flowr implements FragmentManager.OnBackStackChangedListener,
 
     private List<FlowrDeepLinkHandler> deepLinkHandlers;
 
-
     /**
      * Constructor to use when creating a new router for an activity
      * that has no toolbar.
@@ -250,6 +249,12 @@ protected final String getTagPrefix() {
         return tagPrefix;
     }
 
+    /**
+     *
+     * @param data  TransactionData used to configure fragment transaction
+     * @param <T>   type Fragment & FlowrFragment
+     * @return      id Identifier of the committed transaction.
+     */
     protected <T extends Fragment & FlowrFragment> int displayFragment(TransactionData<T> data) {
         int identifier = -1;
         try {
@@ -288,7 +293,6 @@ protected <T extends Fragment & FlowrFragment> int displayFragment(TransactionDa
             if (data.isSkipBackStack()) {
                 setCurrentFragment(fragment);
             }
-
         } catch (Exception e) {
             Log.e(TAG, "Error while displaying fragment.", e);
         }
@@ -406,9 +410,9 @@ public void close(int n) {
 
     /**
      * Closes the current activity if the fragments back stack is empty,
-     * otherwise pop the top n fragments from the stack.
+     * otherwise pop upto fragments with id Identifier from the stack.
      *
-     * @param id Identifier of the stated to be popped.
+     * @param id    Identifier of the committed transaction.
      */
     public void closeUpto(int id) {
         if (screen == null) {
@@ -451,10 +455,10 @@ public void closeWithResults(ResultResponse resultResponse, int n) {
 
     /**
      * Closes the current activity if the fragments back stack is empty,
-     * otherwise pop the top n fragments from the stack and publish the results response.
+     * otherwise pop upto fragments with id Identifier from the stack and publish the results response.
      *
-     * @param resultResponse the results response to be published
-     * @param id Identifier of the stated to be popped.
+     * @param resultResponse    the results response to be published
+     * @param id                Identifier of the committed transaction.
      */
     public void closeUptoWithResults(ResultResponse resultResponse, int id) {
         closeUpto(id);
@@ -778,7 +782,7 @@ public Builder noTransactionAnimation() {
         /**
          * Displays the fragment using this builder configurations.
          *
-         * @return id Identifier of the stated to be popped.
+         * @return id Identifier of the committed transaction.
          */
         public int displayFragment() {
             return Flowr.this.displayFragment(data);
@@ -792,7 +796,7 @@ public int displayFragment() {
          * @param requestCode this code will be returned in {@link ResultResponse} when the fragment is closed,
          *                    and it can be used to identify the request from which the results were returned.
          *
-         * @return id Identifier of the stated to be popped.
+         * @return id Identifier of the committed transaction.
          */
         public int displayFragmentForResults(String fragmentId, int requestCode) {
             if (!TextUtils.isEmpty(fragmentId)) {

sample/src/main/java/com/fueled/flowr/sample/FirstFragment.java

@@ -6,8 +6,6 @@
 import com.fueled.flowr.annotations.DeepLink;
 import com.fueled.flowr.sample.core.AbstractFragment;
 
-import static com.fueled.flowr.sample.core.FragmentResultPublisherImpl.sourceFragmentId;
-
 /**
  * Created by [email protected] on 18/05/2017.
  * Copyright (c) 2017 Fueled. All rights reserved.
@@ -39,6 +37,6 @@ public NavigationIconType getNavigationIconType() {
     @Override
     public void onClick(View view) {
         getFlowr().open("/second")
-                .displayFragmentForResults(sourceFragmentId, HomeFragment.RC_STACK);
+                .displayFragmentForResults(HomeFragment.targetFragmentId, HomeFragment.RC_STACK);
     }
 }

sample/src/main/java/com/fueled/flowr/sample/HomeFragment.java

@@ -9,16 +9,15 @@
 import com.fueled.flowr.sample.core.AbstractFragment;
 import com.fueled.flowr.sample.databinding.FragmentHomeBinding;
 
-import static com.fueled.flowr.sample.core.FragmentResultPublisherImpl.backStackIdentifier;
-import static com.fueled.flowr.sample.core.FragmentResultPublisherImpl.sourceFragmentId;
-
 /**
  * Created by [email protected] on 13/02/2017.
  * Copyright (c) 2017 Fueled. All rights reserved.
  */
 public class HomeFragment extends AbstractFragment implements View.OnClickListener {
 
     public static final int RC_STACK = 101;
+    public static int backStackIdentifier;
+    public static String targetFragmentId;
 
     private FragmentHomeBinding binding;
 
@@ -71,9 +70,9 @@ private void displayLinkFragment() {
     }
 
     private void displayFirstFragment() {
-        sourceFragmentId = getFragmentId();
+        targetFragmentId = getFragmentId();
         backStackIdentifier = getFlowr().open("/first")
-                .displayFragmentForResults(sourceFragmentId, RC_STACK);
+                .displayFragmentForResults(targetFragmentId, RC_STACK);
     }
 
     @Override

sample/src/main/java/com/fueled/flowr/sample/SecondFragment.java

@@ -10,8 +10,6 @@
 import com.fueled.flowr.annotations.DeepLink;
 import com.fueled.flowr.sample.core.AbstractFragment;
 
-import static com.fueled.flowr.sample.core.FragmentResultPublisherImpl.backStackIdentifier;
-
 /**
  * Created by [email protected] on 18/05/2017.
  * Copyright (c) 2017 Fueled. All rights reserved.
@@ -46,7 +44,7 @@ public NavigationIconType getNavigationIconType() {
     public void onClick(View view) {
         getFlowr().closeUptoWithResults(
                 Flowr.getResultsResponse(getArguments(), Activity.RESULT_OK, getBundle()),
-                backStackIdentifier);
+                HomeFragment.backStackIdentifier);
     }
 
     @NonNull

sample/src/main/java/com/fueled/flowr/sample/core/FragmentResultPublisherImpl.java

@@ -52,7 +52,4 @@ public static FragmentResultPublisherImpl getInstance() {
 
         return instance;
     }
-
-    public static int backStackIdentifier;
-    public static String sourceFragmentId;
 }