public class

ListChangeRegistry

extends CallbackRegistry<ObservableList.OnListChangedCallback, ObservableList, androidx.databinding.ListChangeRegistry.ListChanges>

 java.lang.Object

androidx.databinding.CallbackRegistry<ObservableList.OnListChangedCallback, ObservableList, androidx.databinding.ListChangeRegistry.ListChanges>

↳androidx.databinding.ListChangeRegistry

Gradle dependencies

compile group: 'androidx.databinding', name: 'databinding-runtime', version: '8.8.0-alpha01'

  • groupId: androidx.databinding
  • artifactId: databinding-runtime
  • version: 8.8.0-alpha01

Artifact androidx.databinding:databinding-runtime:8.8.0-alpha01 it located at Google repository (https://maven.google.com/)

Androidx class mapping:

androidx.databinding.ListChangeRegistry android.databinding.ListChangeRegistry

Overview

Utility class for managing ObservableList callbacks.

Summary

Constructors
publicListChangeRegistry()

Methods
public synchronized voidnotifyCallbacks(java.lang.Object sender, int arg, java.lang.Object arg2)

Notify all callbacks.

public voidnotifyChanged(ObservableList list)

Notify registered callbacks that there was an unknown or whole-list change.

public voidnotifyChanged(ObservableList list, int start, int count)

Notify registered callbacks that some elements have changed.

public voidnotifyInserted(ObservableList list, int start, int count)

Notify registered callbacks that elements were inserted.

public voidnotifyMoved(ObservableList list, int from, int to, int count)

Notify registered callbacks that elements were moved.

public voidnotifyRemoved(ObservableList list, int start, int count)

Notify registered callbacks that elements were deleted.

from CallbackRegistry<C, T, A>add, clear, clone, copyCallbacks, copyCallbacks, isEmpty, remove
from java.lang.Objectequals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructors

public ListChangeRegistry()

Methods

public void notifyChanged(ObservableList list)

Notify registered callbacks that there was an unknown or whole-list change.

Parameters:

list: The list that changed.

public void notifyChanged(ObservableList list, int start, int count)

Notify registered callbacks that some elements have changed.

Parameters:

list: The list that changed.
start: The index of the first changed element.
count: The number of changed elements.

public void notifyInserted(ObservableList list, int start, int count)

Notify registered callbacks that elements were inserted.

Parameters:

list: The list that changed.
start: The index where the elements were inserted.
count: The number of elements that were inserted.

public void notifyMoved(ObservableList list, int from, int to, int count)

Notify registered callbacks that elements were moved.

Parameters:

list: The list that changed.
from: The index of the first element moved.
to: The index of where the element was moved to.
count: The number of elements moved.

public void notifyRemoved(ObservableList list, int start, int count)

Notify registered callbacks that elements were deleted.

Parameters:

list: The list that changed.
start: The index of the first element to be removed.
count: The number of elements removed.

public synchronized void notifyCallbacks(java.lang.Object sender, int arg, java.lang.Object arg2)

Notify all callbacks.

Parameters:

sender: The originator. This is an opaque parameter passed to CallbackRegistry.NotifierCallback.onNotifyCallback(C, T, int, A)
arg: An opaque parameter passed to CallbackRegistry.NotifierCallback.onNotifyCallback(C, T, int, A)
arg2: An opaque parameter passed to CallbackRegistry.NotifierCallback.onNotifyCallback(C, T, int, A)

Source

/*
 * Copyright (C) 2015 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package androidx.databinding;

import androidx.annotation.NonNull;
import androidx.core.util.Pools;

/**
 * Utility class for managing ObservableList callbacks.
 */
public class ListChangeRegistry
        extends
        CallbackRegistry<ObservableList.OnListChangedCallback, ObservableList,
                ListChangeRegistry.ListChanges> {
    private static final Pools.SynchronizedPool<ListChanges> sListChanges =
            new Pools.SynchronizedPool<ListChanges>(10);

    private static final int ALL = 0;
    private static final int CHANGED = 1;
    private static final int INSERTED = 2;
    private static final int MOVED = 3;
    private static final int REMOVED = 4;

    private static final CallbackRegistry.NotifierCallback<ObservableList.OnListChangedCallback,
            ObservableList, ListChanges> NOTIFIER_CALLBACK = new CallbackRegistry.NotifierCallback<
            ObservableList.OnListChangedCallback, ObservableList, ListChanges>() {
        @Override
        public void onNotifyCallback(ObservableList.OnListChangedCallback callback,
                ObservableList sender, int notificationType, ListChanges listChanges) {
            switch (notificationType) {
                case CHANGED:
                    callback.onItemRangeChanged(sender, listChanges.start, listChanges.count);
                    break;
                case INSERTED:
                    callback.onItemRangeInserted(sender, listChanges.start, listChanges.count);
                    break;
                case MOVED:
                    callback.onItemRangeMoved(sender, listChanges.start, listChanges.to,
                            listChanges.count);
                    break;
                case REMOVED:
                    callback.onItemRangeRemoved(sender, listChanges.start, listChanges.count);
                    break;
                default:
                    callback.onChanged(sender);
                    break;
            }
        }
    };

    /**
     * Notify registered callbacks that there was an unknown or whole-list change.
     *
     * @param list The list that changed.
     */
    public void notifyChanged(@NonNull ObservableList list) {
        notifyCallbacks(list, ALL, null);
    }

    /**
     * Notify registered callbacks that some elements have changed.
     *
     * @param list The list that changed.
     * @param start The index of the first changed element.
     * @param count The number of changed elements.
     */
    public void notifyChanged(@NonNull ObservableList list, int start, int count) {
        ListChanges listChanges = acquire(start, 0, count);
        notifyCallbacks(list, CHANGED, listChanges);
    }

    /**
     * Notify registered callbacks that elements were inserted.
     *
     * @param list The list that changed.
     * @param start The index where the elements were inserted.
     * @param count The number of elements that were inserted.
     */
    public void notifyInserted(@NonNull ObservableList list, int start, int count) {
        ListChanges listChanges = acquire(start, 0, count);
        notifyCallbacks(list, INSERTED, listChanges);
    }

    /**
     * Notify registered callbacks that elements were moved.
     *
     * @param list The list that changed.
     * @param from The index of the first element moved.
     * @param to The index of where the element was moved to.
     * @param count The number of elements moved.
     */
    public void notifyMoved(@NonNull ObservableList list, int from, int to, int count) {
        ListChanges listChanges = acquire(from, to, count);
        notifyCallbacks(list, MOVED, listChanges);
    }

    /**
     * Notify registered callbacks that elements were deleted.
     *
     * @param list The list that changed.
     * @param start The index of the first element to be removed.
     * @param count The number of elements removed.
     */
    public void notifyRemoved(@NonNull ObservableList list, int start, int count) {
        ListChanges listChanges = acquire(start, 0, count);
        notifyCallbacks(list, REMOVED, listChanges);
    }

    private static ListChanges acquire(int start, int to, int count) {
        ListChanges listChanges = sListChanges.acquire();
        if (listChanges == null) {
            listChanges = new ListChanges();
        }
        listChanges.start = start;
        listChanges.to = to;
        listChanges.count = count;
        return listChanges;
    }

    @Override
    public synchronized void notifyCallbacks(@NonNull ObservableList sender, int notificationType,
            ListChanges listChanges) {
        super.notifyCallbacks(sender, notificationType, listChanges);
        if (listChanges != null) {
            sListChanges.release(listChanges);
        }
    }

    public ListChangeRegistry() {
        super(NOTIFIER_CALLBACK);
    }

    static class ListChanges {
        public int start;
        public int count;
        public int to;
    }
}