public class

SharedValues

extends java.lang.Object

 java.lang.Object

↳androidx.constraintlayout.widget.SharedValues

Gradle dependencies

compile group: 'androidx.constraintlayout', name: 'constraintlayout', version: '2.2.0-beta01'

  • groupId: androidx.constraintlayout
  • artifactId: constraintlayout
  • version: 2.2.0-beta01

Artifact androidx.constraintlayout:constraintlayout:2.2.0-beta01 it located at Google repository (https://maven.google.com/)

Androidx artifact mapping:

androidx.constraintlayout:constraintlayout com.android.support.constraint:constraint-layout

Overview

Shared values

Summary

Fields
public static final intUNSET

Constructors
publicSharedValues()

Methods
public voidaddListener(int key, SharedValues.SharedValuesListener listener)

Add a listener for a key

public voidclearListeners()

remove all listeners

public voidfireNewValue(int key, int value)

notify that value has changed

public intgetValue(int key)

get the value from the map

public voidremoveListener(int key, SharedValues.SharedValuesListener listener)

Remove listener for a key (will not be removed for other keys)

public voidremoveListener(SharedValues.SharedValuesListener listener)

Remove a listener

from java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Fields

public static final int UNSET

Constructors

public SharedValues()

Methods

public void addListener(int key, SharedValues.SharedValuesListener listener)

Add a listener for a key

Parameters:

key:
listener:

public void removeListener(int key, SharedValues.SharedValuesListener listener)

Remove listener for a key (will not be removed for other keys)

Parameters:

key:
listener:

public void removeListener(SharedValues.SharedValuesListener listener)

Remove a listener

Parameters:

listener:

public void clearListeners()

remove all listeners

public int getValue(int key)

get the value from the map

Parameters:

key:

Returns:

public void fireNewValue(int key, int value)

notify that value has changed

Parameters:

key:
value:

Source

/*
 * Copyright (C) 2020 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.constraintlayout.widget;

import android.util.SparseIntArray;

import java.lang.ref.WeakReference;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;

/**
 * Shared values
 */
public class SharedValues {
    public static final int UNSET = -1;

    private SparseIntArray mValues = new SparseIntArray();
    private HashMap<Integer, HashSet<WeakReference<SharedValuesListener>>> mValuesListeners =
            new HashMap<>();

    /**
     * interface for listeners
     */
    public interface SharedValuesListener {
        // @TODO: add description

        /**
         *
         * @param key
         * @param newValue
         * @param oldValue
         */
        void onNewValue(int key, int newValue, int oldValue);
    }

    /**
     * Add a listener for a key
     * @param key
     * @param listener
     */
    public void addListener(int key, SharedValuesListener listener) {
        HashSet<WeakReference<SharedValuesListener>> listeners = mValuesListeners.get(key);
        if (listeners == null) {
            listeners = new HashSet<>();
            mValuesListeners.put(key, listeners);
        }
        listeners.add(new WeakReference<>(listener));
    }

    /**
     * Remove listener for a key (will not be removed for other keys)
     * @param key
     * @param listener
     */
    public void removeListener(int key, SharedValuesListener listener) {
        HashSet<WeakReference<SharedValuesListener>> listeners = mValuesListeners.get(key);
        if (listeners == null) {
            return;
        }
        List<WeakReference<SharedValuesListener>> toRemove = new ArrayList<>();
        for (WeakReference<SharedValuesListener> listenerWeakReference : listeners) {
            SharedValuesListener l = listenerWeakReference.get();
            if (l == null || l == listener) {
                toRemove.add(listenerWeakReference);
            }
        }
        listeners.removeAll(toRemove);
    }

    /**
     * Remove a listener
     * @param listener
     */
    public void removeListener(SharedValuesListener listener) {
        for (Integer key : mValuesListeners.keySet()) {
            removeListener(key, listener);
        }
    }

    /**
     * remove all listeners
     */
    public void clearListeners() {
        mValuesListeners.clear();
    }

    /**
     * get the value from the map
     * @param key
     * @return
     */
    public int getValue(int key) {
        return mValues.get(key, UNSET);
    }

    /**
     * notify that value has changed
     * @param key
     * @param value
     */
    public void fireNewValue(int key, int value) {
        boolean needsCleanup = false;
        int previousValue = mValues.get(key, UNSET);
        if (previousValue == value) {
            // don't send the value to listeners if it's the same one.
            return;
        }
        mValues.put(key, value);
        HashSet<WeakReference<SharedValuesListener>> listeners = mValuesListeners.get(key);
        if (listeners == null) {
            return;
        }

        for (WeakReference<SharedValuesListener> listenerWeakReference : listeners) {
            SharedValuesListener l = listenerWeakReference.get();
            if (l != null) {
                l.onNewValue(key, value, previousValue);
            } else {
                needsCleanup = true;
            }
        }

        if (needsCleanup) {
            List<WeakReference<SharedValuesListener>> toRemove = new ArrayList<>();
            for (WeakReference<SharedValuesListener> listenerWeakReference : listeners) {
                SharedValuesListener listener = listenerWeakReference.get();
                if (listener == null) {
                    toRemove.add(listenerWeakReference);
                }
            }
            listeners.removeAll(toRemove);
        }
    }
}