Stable
-
Cmn
@MustBeDocumented
@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY])
@Retention(value = AnnotationRetention.BINARY)
@StableMarker
annotation Stable
Stable is used to communicate some guarantees to the compose compiler about how a certain type or function will behave.
When applied to a class or an interface, Stable indicates that the following must be true:
-
The result of
equalswill always return the same result for the same two instances. -
When a public property of the type changes, composition will be notified.
-
All public property types are stable.
When applied to a function or a property, the Stable annotation indicates that the function will return the same result if the same parameters are passed in. This is only meaningful if the parameters and results are themselves Stable, Immutable, or primitive.
The invariants that this annotation implies are used for optimizations by the compose compiler, and have undefined behavior if the above assumptions are not met. As a result, one should not use this annotation unless they are certain that these conditions are satisfied.
| See also | |
|---|---|
Immutable |
|
StableMarker |
Summary
Public constructors |
|
|---|---|
Stable() |
Cmn
|