1 /* 2 * Copyright (C) 2023 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 package com.android.systemui.statusbar.notification.interruption 18 19 import com.android.systemui.Flags 20 import com.android.systemui.flags.FlagToken 21 import com.android.systemui.flags.RefactorFlagUtils 22 23 /** Helper for reading or using the visual interruptions refactor flag state. */ 24 object VisualInterruptionRefactor { 25 const val FLAG_NAME = Flags.FLAG_VISUAL_INTERRUPTIONS_REFACTOR 26 27 /** A token used for dependency declaration */ 28 val token: FlagToken 29 get() = FlagToken(FLAG_NAME, isEnabled) 30 31 /** Whether the refactor is enabled */ 32 @JvmStatic 33 inline val isEnabled 34 get() = Flags.visualInterruptionsRefactor() 35 36 /** 37 * Called to ensure code is only run when the flag is enabled. This protects users from the 38 * unintended behaviors caused by accidentally running new logic, while also crashing on an eng 39 * build to ensure that the refactor author catches issues in testing. 40 */ 41 @JvmStatic isUnexpectedlyInLegacyModenull42 inline fun isUnexpectedlyInLegacyMode() = 43 RefactorFlagUtils.isUnexpectedlyInLegacyMode(isEnabled, FLAG_NAME) 44 45 /** 46 * Called to ensure code is only run when the flag is disabled. This will throw an exception if 47 * the flag is enabled to ensure that the refactor author catches issues in testing. 48 */ 49 @JvmStatic 50 inline fun assertInLegacyMode() = RefactorFlagUtils.assertInLegacyMode(isEnabled, FLAG_NAME) 51 } 52