Package arez.annotations

@OmitPattern package arez.annotations

This package contains annotations used by the annotation processor to generate model elements.

Related Packages

Package	Description
arez	Core Arez primitives.

Class	Description
ActAsComponent	Annotation added to a class or interface that indicates that the type should be treated as a component when verifying references to type.
Action	Methods marked with this annotation are invoked in an Arez transaction.
ArezComponent	Annotation that marks classes or interfaces to be processed by Arez annotation processor.
CascadeDispose	Methods and fields annotated by this annotation should be disposed when the component is disposed.
ComponentDependency	Methods and fields marked with this annotation are dependencies of the component.
ComponentDependency.Action	The action to take when dependency is disposed.
ComponentId	Annotate the method that should return the Id for Arez component.
ComponentIdRef	Marks a template method that returns the Id of the component.
ComponentNameRef	Annotate the method that will be overridden to provide the "name" of the Arez component.
ComponentRef	Marks a template method that returns the Component instance for the component.
ComponentStateRef	Annotate the method that will be overridden to return true if the component is in the specified state.
ComponentTypeNameRef	Annotate the method that will be overridden to return the value of ArezComponent.name().
ComputableValueRef	Marks a template method that returns the ComputableValue instance for the Memoize annotated property.
ContextRef	Marks a template method that returns the ArezContext instance for component.
DepType	Enumeration that describes the types of dependencies supported by an Observer or a ComputableValue.
Executor	Enum describing the executor responsible for executing the Observer's observe method.
Feature	Enum to control if a feature should be enabled.
Inverse	The Inverse annotation is used to annotate the reverse direction of the relationship annotated by the Reference annotation.
LinkType	Defines the strategy for loading references from the Locator.
Memoize	Methods marked with this annotation are memoized while activated which typically means they have an observer.
Multiplicity	Defines the multiplicity of the Inverse relationship for Reference.
Observable	Annotation applied to methods that expose an ObservableValue value in Arez.
ObservableValueRef	Marks a template method that returns the ObservableValue instance for the Observable annotated property.
Observe	Annotation that marks a method as observed.
ObserverRef	Marks a template method that returns the Observer instance for the associated Observe annotated method.
OnActivate	Identifies method that is called when the ComputableValue changes from the INACTIVE state to any other state.
OnDeactivate	Identifies method that is called when the ComputableValue changes to the INACTIVE state from any other state.
OnDepsChange	Identifies method that will be invoked when the dependencies of the paired Observe annotated method are changed.
PostConstruct	Annotation to identify method that is invoked after the component is constructed.
PostDispose	Annotation to identify method that is invoked after the component is disposed.
PostInverseAdd	Identifies a method that will be invoked after an inverse reference is added to a component.
PreDispose	Annotation to identify method that is invoked before the component is disposed.
PreInverseRemove	Identifies a method that will be invoked before an inverse reference is removed from a component.
Priority	Enum to control scheduling priority of observers/reactions.
Reference	A Reference annotation is placed on an abstract method that will resolve to a referenced object.
ReferenceId	This annotation designates the method used to retrieve the id of the reference.
State	Defines the states of a component.
SuppressArezWarnings	Indicate that the named Arez compiler warnings should be suppressed in the annotated element (and in all program elements contained in the annotated element).