Package org.axonframework.common.annotation

Annotation Interface RegistrationScope

@Documented @Retention(RUNTIME) @Target({TYPE,ANNOTATION_TYPE}) public @interface RegistrationScope
Marker to specify the registration scope for objects that are registered in the registry.

Whenever the scope is set to RegistrationScope.Scope.CURRENT, the annotated component will never be copied to a child registry once it's created. Using the scope RegistrationScope.Scope.CHILDREN will ensure the annotated component is copied to a child registry (and later to its children), once it's created.

This annotation is intended to be put on ConfigurationEnhancer and DecoratorDefinition classes to control their registration scopes.

Since:
5.1.0
Author:
Simon Zambrovski

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    RegistrationScope.Scope
    Registration scope.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    RegistrationScope.Scope
    scope
    Sets the registration scope for the instance.
    String
    value
    Optional description of the reason.

  • Element Details

    • value

      String value
      Optional description of the reason.
      Returns:
      A description of the reason.
      Default:
      ""

    • scope

      RegistrationScope.Scope scope
      Sets the registration scope for the instance.
      Returns:
      The registration scope.
      Default:
      CURRENT