chrome/browser/tab/java/src/org/chromium/chrome/browser/tab/TabStateAttributes.java

// Copyright 2022 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

package org.chromium.chrome.browser.tab;

import org.chromium.base.UserData;
import org.chromium.base.UserDataHost;

/**
 * Attributes related to {@link TabState}
 */
public class TabStateAttributes implements UserData {
    private static final Class<TabStateAttributes> USER_DATA_KEY = TabStateAttributes.class;
    /** Whether or not the TabState has changed. */
    private boolean mIsTabStateDirty = true;

    /**
     * @return {@link TabStateAttributes} for a {@link Tab}
     */
    public static TabStateAttributes from(Tab tab) {
        UserDataHost host = tab.getUserDataHost();
        TabStateAttributes attrs = host.getUserData(USER_DATA_KEY);
        return attrs != null ? attrs : host.setUserData(USER_DATA_KEY, new TabStateAttributes());
    }

    private TabStateAttributes() {}

    /**
     * @return true if the {@link TabState} has been changed
     */
    public boolean isTabStateDirty() {
        return mIsTabStateDirty;
    }

    /**
     * Set whether the TabState representing this Tab has been updated.
     * This method will ultimately be deprecated when the migration
     * to CriticalPersistedTabData is complete.
     * @param isTabStateDirty whether the Tab's state has changed.
     */
    public void setIsTabStateDirty(boolean isTabStateDirty) {
        mIsTabStateDirty = isTabStateDirty;
    }
}