1 /* 2 * Copyright 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 androidx.compose.runtime.snapshots 18 19 /** 20 * Designates a function as a factory function that produces a State object. Since State factory 21 * functions create and initialize a state, they should usually only be called once per state value 22 * initialization. This annotation causes all invocations of marked state factory functions to be 23 * checked to ensure that they are not called directly inside the body of a [Composable] function 24 * and are instead wrapped with an appropriate [remember] call. 25 */ 26 @MustBeDocumented 27 @Target(AnnotationTarget.FUNCTION) 28 @Retention(AnnotationRetention.BINARY) 29 annotation class StateFactoryMarker 30