@Documented @Target(METHOD) public @interface ComponentId

Annotate the method that should return the Id for Arez component.

This annotation should appear at most once on a component. The annotation should be on a method that accepts no parameters and returns a non-null value.

If this annotation is present, it indicates that the Annotation processor should call this method to get the ID of the component. This ID should be constant and unique (enough) to identify the component. It is used when generating debug names for observables nested within the component. It is also used as the id under which an component is stored when repositories are being generated. If this annotation is not present the Annotation processor will synthesize an ID as a monotonically increasing integer for each instance of the type.

It should also be noted that this method will be invoked before the component has been completely constructed as it is used during construction of the reactive elements.

The method that is annotated with this annotation must comply with the additional constraints:

Must not be annotated with any other arez annotation
Must have 0 parameters
Must return a value
Must not be private
Must not be static
Must not be abstract
Must not throw exceptions
Must be accessible to the class annotated by the ArezComponent annotation.

Annotation Interface ComponentId