Skip to content

Commit 07dd41b

Browse files
Treehugger RobotGerrit Code Review
authored andcommitted
Merge "Add RecyclerView.OnAdapterChangeListener" into androidx-main
2 parents 0466490 + 10bae5d commit 07dd41b

4 files changed

Lines changed: 162 additions & 0 deletions

File tree

‎recyclerview/recyclerview/api/current.txt‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -401,10 +401,12 @@ package androidx.recyclerview.widget {
401401
ctor public RecyclerView(android.content.Context, android.util.AttributeSet?, int);
402402
method public void addItemDecoration(androidx.recyclerview.widget.RecyclerView.ItemDecoration);
403403
method public void addItemDecoration(androidx.recyclerview.widget.RecyclerView.ItemDecoration, int);
404+
method public void addOnAdapterChangeListener(androidx.recyclerview.widget.RecyclerView.OnAdapterChangeListener);
404405
method public void addOnChildAttachStateChangeListener(androidx.recyclerview.widget.RecyclerView.OnChildAttachStateChangeListener);
405406
method public void addOnItemTouchListener(androidx.recyclerview.widget.RecyclerView.OnItemTouchListener);
406407
method public void addOnScrollListener(androidx.recyclerview.widget.RecyclerView.OnScrollListener);
407408
method public void addRecyclerListener(androidx.recyclerview.widget.RecyclerView.RecyclerListener);
409+
method public void clearOnAdapterChangeListeners();
408410
method public void clearOnChildAttachStateChangeListeners();
409411
method public void clearOnScrollListeners();
410412
method public int computeHorizontalScrollExtent();
@@ -462,6 +464,7 @@ package androidx.recyclerview.widget {
462464
method public void onScrolled(@Px int, @Px int);
463465
method public void removeItemDecoration(androidx.recyclerview.widget.RecyclerView.ItemDecoration);
464466
method public void removeItemDecorationAt(int);
467+
method public void removeOnAdapterChangeListener(androidx.recyclerview.widget.RecyclerView.OnAdapterChangeListener);
465468
method public void removeOnChildAttachStateChangeListener(androidx.recyclerview.widget.RecyclerView.OnChildAttachStateChangeListener);
466469
method public void removeOnItemTouchListener(androidx.recyclerview.widget.RecyclerView.OnItemTouchListener);
467470
method public void removeOnScrollListener(androidx.recyclerview.widget.RecyclerView.OnScrollListener);
@@ -816,6 +819,10 @@ package androidx.recyclerview.widget {
816819
method public boolean viewNeedsUpdate();
817820
}
818821

822+
public static interface RecyclerView.OnAdapterChangeListener {
823+
method public void onAdapterChanged(androidx.recyclerview.widget.RecyclerView.Adapter<? extends java.lang.Object!>?, androidx.recyclerview.widget.RecyclerView.Adapter<? extends java.lang.Object!>?);
824+
}
825+
819826
public static interface RecyclerView.OnChildAttachStateChangeListener {
820827
method public void onChildViewAttachedToWindow(android.view.View);
821828
method public void onChildViewDetachedFromWindow(android.view.View);

‎recyclerview/recyclerview/api/restricted_current.txt‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -401,10 +401,12 @@ package androidx.recyclerview.widget {
401401
ctor public RecyclerView(android.content.Context, android.util.AttributeSet?, int);
402402
method public void addItemDecoration(androidx.recyclerview.widget.RecyclerView.ItemDecoration);
403403
method public void addItemDecoration(androidx.recyclerview.widget.RecyclerView.ItemDecoration, int);
404+
method public void addOnAdapterChangeListener(androidx.recyclerview.widget.RecyclerView.OnAdapterChangeListener);
404405
method public void addOnChildAttachStateChangeListener(androidx.recyclerview.widget.RecyclerView.OnChildAttachStateChangeListener);
405406
method public void addOnItemTouchListener(androidx.recyclerview.widget.RecyclerView.OnItemTouchListener);
406407
method public void addOnScrollListener(androidx.recyclerview.widget.RecyclerView.OnScrollListener);
407408
method public void addRecyclerListener(androidx.recyclerview.widget.RecyclerView.RecyclerListener);
409+
method public void clearOnAdapterChangeListeners();
408410
method public void clearOnChildAttachStateChangeListeners();
409411
method public void clearOnScrollListeners();
410412
method public int computeHorizontalScrollExtent();
@@ -462,6 +464,7 @@ package androidx.recyclerview.widget {
462464
method public void onScrolled(@Px int, @Px int);
463465
method public void removeItemDecoration(androidx.recyclerview.widget.RecyclerView.ItemDecoration);
464466
method public void removeItemDecorationAt(int);
467+
method public void removeOnAdapterChangeListener(androidx.recyclerview.widget.RecyclerView.OnAdapterChangeListener);
465468
method public void removeOnChildAttachStateChangeListener(androidx.recyclerview.widget.RecyclerView.OnChildAttachStateChangeListener);
466469
method public void removeOnItemTouchListener(androidx.recyclerview.widget.RecyclerView.OnItemTouchListener);
467470
method public void removeOnScrollListener(androidx.recyclerview.widget.RecyclerView.OnScrollListener);
@@ -816,6 +819,10 @@ package androidx.recyclerview.widget {
816819
method public boolean viewNeedsUpdate();
817820
}
818821

822+
public static interface RecyclerView.OnAdapterChangeListener {
823+
method public void onAdapterChanged(androidx.recyclerview.widget.RecyclerView.Adapter<? extends java.lang.Object!>?, androidx.recyclerview.widget.RecyclerView.Adapter<? extends java.lang.Object!>?);
824+
}
825+
819826
public static interface RecyclerView.OnChildAttachStateChangeListener {
820827
method public void onChildViewAttachedToWindow(android.view.View);
821828
method public void onChildViewDetachedFromWindow(android.view.View);

‎recyclerview/recyclerview/src/androidTest/java/androidx/recyclerview/widget/RecyclerViewBasicTest.java‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@
6060
import androidx.test.filters.SmallTest;
6161

6262
import org.jspecify.annotations.NonNull;
63+
import org.jspecify.annotations.Nullable;
6364
import org.junit.Before;
6465
import org.junit.Ignore;
6566
import org.junit.Test;
@@ -688,6 +689,74 @@ public void notifyDataSetChanged_callsCorrectLmMethods() throws Throwable {
688689
assertEquals(1, mockLayoutManager.mItemsChangedCount);
689690
}
690691

692+
@Test
693+
public void setAdapter_callsCorrectAdapterListenerMethods() throws Throwable {
694+
MockOnAdapterChangeListener firstAdapterListener = new MockOnAdapterChangeListener() {
695+
@Override
696+
public void onAdapterChanged(RecyclerView.@Nullable Adapter<?> oldAdapter,
697+
RecyclerView.@Nullable Adapter<?> newAdapter) {
698+
super.onAdapterChanged(oldAdapter, newAdapter);
699+
mRecyclerView.removeOnAdapterChangeListener(this);
700+
}
701+
};
702+
MockOnAdapterChangeListener secondAdapterListener = new MockOnAdapterChangeListener() {
703+
@Override
704+
public void onAdapterChanged(RecyclerView.@Nullable Adapter<?> oldAdapter,
705+
RecyclerView.@Nullable Adapter<?> newAdapter) {
706+
super.onAdapterChanged(oldAdapter, newAdapter);
707+
mRecyclerView.removeOnAdapterChangeListener(this);
708+
}
709+
};
710+
MockAdapter firstAdapter = new MockAdapter(0);
711+
MockAdapter secondAdapter = new MockAdapter(0);
712+
mRecyclerView.addOnAdapterChangeListener(firstAdapterListener);
713+
mRecyclerView.addOnAdapterChangeListener(secondAdapterListener);
714+
715+
mRecyclerView.setAdapter(firstAdapter);
716+
mRecyclerView.setAdapter(secondAdapter);
717+
718+
assertEquals(1, firstAdapterListener.mAdapterChangedCount);
719+
assertNull(firstAdapterListener.mOldAdapter);
720+
assertSame(firstAdapter, firstAdapterListener.mNewAdapter);
721+
assertEquals(1, secondAdapterListener.mAdapterChangedCount);
722+
assertNull(secondAdapterListener.mOldAdapter);
723+
assertSame(firstAdapter, secondAdapterListener.mNewAdapter);
724+
}
725+
726+
@Test
727+
public void swapAdapter_callsCorrectAdapterListenerMethods() throws Throwable {
728+
MockOnAdapterChangeListener firstAdapterListener = new MockOnAdapterChangeListener() {
729+
@Override
730+
public void onAdapterChanged(RecyclerView.@Nullable Adapter<?> oldAdapter,
731+
RecyclerView.@Nullable Adapter<?> newAdapter) {
732+
super.onAdapterChanged(oldAdapter, newAdapter);
733+
mRecyclerView.removeOnAdapterChangeListener(this);
734+
}
735+
};
736+
MockOnAdapterChangeListener secondAdapterListener = new MockOnAdapterChangeListener() {
737+
@Override
738+
public void onAdapterChanged(RecyclerView.@Nullable Adapter<?> oldAdapter,
739+
RecyclerView.@Nullable Adapter<?> newAdapter) {
740+
super.onAdapterChanged(oldAdapter, newAdapter);
741+
mRecyclerView.removeOnAdapterChangeListener(this);
742+
}
743+
};
744+
MockAdapter firstAdapter = new MockAdapter(0);
745+
MockAdapter secondAdapter = new MockAdapter(0);
746+
mRecyclerView.addOnAdapterChangeListener(firstAdapterListener);
747+
mRecyclerView.addOnAdapterChangeListener(secondAdapterListener);
748+
749+
mRecyclerView.swapAdapter(firstAdapter, true);
750+
mRecyclerView.swapAdapter(secondAdapter, true);
751+
752+
assertEquals(1, firstAdapterListener.mAdapterChangedCount);
753+
assertNull(firstAdapterListener.mOldAdapter);
754+
assertSame(firstAdapter, firstAdapterListener.mNewAdapter);
755+
assertEquals(1, secondAdapterListener.mAdapterChangedCount);
756+
assertNull(secondAdapterListener.mOldAdapter);
757+
assertSame(firstAdapter, secondAdapterListener.mNewAdapter);
758+
}
759+
691760
static class MockLayoutManager extends RecyclerView.LayoutManager {
692761

693762
int mLayoutCount = 0;
@@ -859,6 +928,23 @@ public MockViewHolder(View itemView) {
859928
}
860929
}
861930

931+
static class MockOnAdapterChangeListener implements RecyclerView.OnAdapterChangeListener {
932+
933+
int mAdapterChangedCount = 0;
934+
935+
RecyclerView.Adapter<?> mOldAdapter;
936+
937+
RecyclerView.Adapter<?> mNewAdapter;
938+
939+
@Override
940+
public void onAdapterChanged(RecyclerView.@Nullable Adapter<?> oldAdapter,
941+
RecyclerView.@Nullable Adapter<?> newAdapter) {
942+
mOldAdapter = oldAdapter;
943+
mNewAdapter = newAdapter;
944+
mAdapterChangedCount++;
945+
}
946+
}
947+
862948
static class LoggingView extends TextView {
863949
private int mOnSavedInstanceCnt = 0;
864950

‎recyclerview/recyclerview/src/main/java/androidx/recyclerview/widget/RecyclerView.java‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -499,6 +499,7 @@ public void run() {
499499
boolean mAdapterUpdateDuringMeasure;
500500

501501
private final AccessibilityManager mAccessibilityManager;
502+
private List<OnAdapterChangeListener> mOnAdapterChangeListeners;
502503
private List<OnChildAttachStateChangeListener> mOnChildAttachStateListeners;
503504

504505
/**
@@ -1360,6 +1361,12 @@ private void setAdapterInternal(@Nullable Adapter<?> adapter, boolean compatible
13601361
mLayout.onAdapterChanged(oldAdapter, mAdapter);
13611362
}
13621363
mRecycler.onAdapterChanged(oldAdapter, mAdapter, compatibleWithPrevious);
1364+
if (mOnAdapterChangeListeners != null) {
1365+
final int cnt = mOnAdapterChangeListeners.size();
1366+
for (int i = cnt - 1; i >= 0; i--) {
1367+
mOnAdapterChangeListeners.get(i).onAdapterChanged(oldAdapter, mAdapter);
1368+
}
1369+
}
13631370
mState.mStructureChanged = true;
13641371
}
13651372

@@ -1432,6 +1439,46 @@ public int getBaseline() {
14321439
}
14331440
}
14341441

1442+
/**
1443+
* Register a listener that will be notified whenever the current adapter is replaced.
1444+
*
1445+
* <p>This listener will be called during {@link #setAdapter(Adapter)} and
1446+
* {@link #swapAdapter(Adapter, boolean)}. Do not call {@link #setAdapter(Adapter)} or
1447+
* {@link #swapAdapter(Adapter, boolean)} from
1448+
* {@link OnAdapterChangeListener#onAdapterChanged(Adapter, Adapter)} since that can lead to
1449+
* infinite recursion.</p>
1450+
*
1451+
* @param listener Listener to register
1452+
*/
1453+
public void addOnAdapterChangeListener(@NonNull OnAdapterChangeListener listener) {
1454+
if (mOnAdapterChangeListeners == null) {
1455+
mOnAdapterChangeListeners = new ArrayList<>();
1456+
}
1457+
mOnAdapterChangeListeners.add(listener);
1458+
}
1459+
1460+
/**
1461+
* Removes the provided listener from adapter listeners list.
1462+
*
1463+
* @param listener Listener to unregister
1464+
*/
1465+
public void removeOnAdapterChangeListener(@NonNull OnAdapterChangeListener listener) {
1466+
if (mOnAdapterChangeListeners == null) {
1467+
return;
1468+
}
1469+
mOnAdapterChangeListeners.remove(listener);
1470+
}
1471+
1472+
/**
1473+
* Removes all listeners that were added via
1474+
* {@link #addOnAdapterChangeListener(OnAdapterChangeListener)}.
1475+
*/
1476+
public void clearOnAdapterChangeListeners() {
1477+
if (mOnAdapterChangeListeners != null) {
1478+
mOnAdapterChangeListeners.clear();
1479+
}
1480+
}
1481+
14351482
/**
14361483
* Register a listener that will be notified whenever a child view is attached to or detached
14371484
* from RecyclerView.
@@ -11955,6 +12002,21 @@ public interface RecyclerListener {
1195512002
void onViewRecycled(@NonNull ViewHolder holder);
1195612003
}
1195712004

12005+
/**
12006+
* A Listener interface that can be attached to a RecyclerView to get notified
12007+
* whenever the current adapter is replaced.
12008+
*/
12009+
public interface OnAdapterChangeListener {
12010+
12011+
/**
12012+
* Called when the current adapter is replaced.
12013+
*
12014+
* @param oldAdapter The old adapter or {@code null} if no adapter was set
12015+
* @param newAdapter The new adapter or {@code null} if no adapter is set
12016+
*/
12017+
void onAdapterChanged(@Nullable Adapter<?> oldAdapter, @Nullable Adapter<?> newAdapter);
12018+
}
12019+
1195812020
/**
1195912021
* A Listener interface that can be attached to a RecylcerView to get notified
1196012022
* whenever a ViewHolder is attached to or detached from RecyclerView.

0 commit comments

Comments
 (0)