0.9.2: remove isPending, added Backstack.isStateChangePending()

Zhuinden · Feb 11, 2017 · 0623594 · 0623594
1 parent 910e748
commit 0623594
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 8 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,15 @@
 # Change log
 
+-Simple Stack 0.9.2 (2017-02-11)
+---------------------------------
+- BREAKING CHANGE(?): `CompletionListener` no longer receives `isPending` parameter.
+
+- ADDED: `Backstack.isStateChangePending()` to replace `isPending`.
+
+- ENHANCEMENT: Added some missing `@NonNull` and `@Nullable` annotations.
+
+- ADDED: Apache license notes, and improved the README.
+
 -Simple Stack 0.9.1 (2017-02-09)
 ---------------------------------
 - BREAKING CHANGE(!): `BackstackDelegate` has a new method which **must be called**: `backstackDelegate.onDestroy()`

diff --git a/README.md b/README.md
@@ -48,7 +48,7 @@ In order to use Simple Stack, you need to add jitpack to your project root gradl
 
 and add the compile dependency to your module level gradle.
 
-    compile 'com.github.Zhuinden:simple-stack:0.9.1'
+    compile 'com.github.Zhuinden:simple-stack:0.9.2'
 
 ## How does it work?
 

diff --git a/simple-stack/src/main/java/com/zhuinden/simplestack/Backstack.java b/simple-stack/src/main/java/com/zhuinden/simplestack/Backstack.java
@@ -123,7 +123,7 @@ public void goTo(@NonNull Parcelable newKey) {
     }
 
     public boolean goBack() {
-        if(!queuedStateChanges.isEmpty() && queuedStateChanges.get(0).getStatus() != PendingStateChange.Status.COMPLETED) {
+        if(isStateChangePending()) {
             return true;
         }
         if(stack.size() <= 1) {
@@ -151,6 +151,10 @@ public List<Parcelable> getHistory() {
         return Collections.unmodifiableList(copy);
     }
 
+    public boolean isStateChangePending() {
+        return !queuedStateChanges.isEmpty();
+    }
+
     private void enqueueStateChange(List<Parcelable> newHistory, int direction, boolean initialization) {
         PendingStateChange pendingStateChange = new PendingStateChange(newHistory, direction, initialization);
         queuedStateChanges.add(pendingStateChange);
@@ -168,7 +172,7 @@ private List<Parcelable> selectActiveHistory() {
     }
 
     private boolean beginStateChangeIfPossible() {
-        if(hasStateChanger() && !queuedStateChanges.isEmpty()) {
+        if(hasStateChanger() && isStateChangePending()) {
             PendingStateChange pendingStateChange = queuedStateChanges.get(0);
             if(pendingStateChange.getStatus() == PendingStateChange.Status.ENQUEUED) {
                 pendingStateChange.setStatus(PendingStateChange.Status.IN_PROGRESS);
@@ -220,7 +224,7 @@ private void completeStateChange(StateChange stateChange) {
 
     // completion listeners
     public interface CompletionListener {
-        void stateChangeCompleted(@NonNull StateChange stateChange, boolean isPending);
+        void stateChangeCompleted(@NonNull StateChange stateChange);
     }
 
     private LinkedList<CompletionListener> completionListeners = new LinkedList<>();
@@ -240,9 +244,8 @@ public void removeCompletionListener(@NonNull CompletionListener completionListe
     }
 
     private void notifyCompletionListeners(StateChange stateChange) {
-        boolean isPending = !queuedStateChanges.isEmpty();
         for(CompletionListener completionListener : completionListeners) {
-            completionListener.stateChangeCompleted(stateChange, isPending);
+            completionListener.stateChangeCompleted(stateChange);
         }
     }
 

diff --git a/simple-stack/src/main/java/com/zhuinden/simplestack/BackstackDelegate.java b/simple-stack/src/main/java/com/zhuinden/simplestack/BackstackDelegate.java
@@ -212,8 +212,8 @@ protected void clearStatesNotIn(@NonNull List<Parcelable> keys) {
     }
 
     @Override
-    public void stateChangeCompleted(@NonNull StateChange stateChange, boolean isPending) {
-        if(!isPending) {
+    public void stateChangeCompleted(@NonNull StateChange stateChange) {
+        if(!backstack.isStateChangePending()) {
             clearStatesNotIn(stateChange.getNewState());
         }
     }