src/com/android/car/settings/users/UserDetailsBasePreferenceController.java

/*
 * Copyright (C) 2018 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 com.android.car.settings.users;

import android.car.drivingstate.CarUxRestrictions;
import android.car.userlib.CarUserManagerHelper;
import android.content.Context;
import android.content.pm.UserInfo;

import androidx.preference.Preference;

import com.android.car.settings.common.FragmentController;
import com.android.car.settings.common.PreferenceController;

/**
 * Common setup of all preference controllers related to user details.
 *
 * @param <V> the upper bound on the type of {@link Preference} on which the controller
 *            expects to operate.
 */
public abstract class UserDetailsBasePreferenceController<V extends Preference> extends
        PreferenceController<V> {

    private final CarUserManagerHelper.OnUsersUpdateListener mOnUsersUpdateListener = () -> {
        refreshUserInfo();
        refreshUi();
    };
    private final CarUserManagerHelper mCarUserManagerHelper;
    private UserInfo mUserInfo;

    public UserDetailsBasePreferenceController(Context context, String preferenceKey,
            FragmentController fragmentController, CarUxRestrictions uxRestrictions) {
        super(context, preferenceKey, fragmentController, uxRestrictions);
        mCarUserManagerHelper = new CarUserManagerHelper(getContext());
    }

    /** Sets the user info for which this preference controller operates. */
    public void setUserInfo(UserInfo userInfo) {
        mUserInfo = userInfo;
    }

    /** Gets the current user info. */
    public UserInfo getUserInfo() {
        return mUserInfo;
    }

    /** Refreshes the user info, since it might have changed. */
    protected void refreshUserInfo() {
        mUserInfo = UserUtils.getUserInfo(getContext(), mUserInfo.id);
    }

    @Override
    protected void checkInitialized() {
        if (mUserInfo == null) {
            throw new IllegalStateException("UserInfo should be non-null by this point");
        }
    }

    /** Registers a listener which updates the displayed user name when a user is modified. */
    @Override
    protected void onCreateInternal() {
        getCarUserManagerHelper().registerOnUsersUpdateListener(mOnUsersUpdateListener);
    }

    /** Unregisters a listener which updates the displayed user name when a user is modified. */
    @Override
    protected void onDestroyInternal() {
        getCarUserManagerHelper().unregisterOnUsersUpdateListener(mOnUsersUpdateListener);
    }

    /** Gets the car user manager helper. */
    protected CarUserManagerHelper getCarUserManagerHelper() {
        return mCarUserManagerHelper;
    }
}