/*
 * Copyright (C) 2024 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.settingslib.datastore

import androidx.annotation.IntDef

/** The reason of data change. */
@IntDef(
    DataChangeReason.UNKNOWN,
    DataChangeReason.UPDATE,
    DataChangeReason.DELETE,
    DataChangeReason.RESTORE,
    DataChangeReason.SYNC_ACROSS_PROFILES,
)
@Retention(AnnotationRetention.SOURCE)
annotation class DataChangeReason {
    companion object {
        /** Unknown reason of the change. */
        const val UNKNOWN = 0
        /** Data is updated. */
        const val UPDATE = 1
        /** Data is deleted. */
        const val DELETE = 2
        /** Data is restored from backup/restore framework. */
        const val RESTORE = 3
        /** Data is synced from another profile (e.g. personal profile to work profile). */
        const val SYNC_ACROSS_PROFILES = 4

        fun isDataChange(reason: Int): Boolean = reason in UNKNOWN..SYNC_ACROSS_PROFILES
    }
}
