Annotation Type GrailsComponentScan


  • @Retention(RUNTIME)
    @Target(TYPE)
    @Documented
    @Import(Registrar.class)
    public @interface GrailsComponentScan
    Configures the base packages used by auto-configuration when scanning for Grails classes.

    Using @GrailsComponentScan will cause auto-configuration to:

    One of basePackageClasses(), basePackages() or its alias value() may be specified to define specific packages to scan. If specific packages are not defined scanning will occur from the package of the class with this annotation.

    Since:
    2022.0.0
    See Also:
    ComponentScan
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.Class<?>[] basePackageClasses
      Type-safe alternative to basePackages() for specifying the packages to scan for entities.
      java.lang.String[] basePackages
      Base packages to scan for entities.
      java.lang.String[] value
      Alias for the basePackages() attribute.
    • Element Detail

      • value

        @AliasFor("basePackages")
        java.lang.String[] value
        Alias for the basePackages() attribute. Allows for more concise annotation declarations e.g.: @EntityScan("org.my.pkg") instead of @GrailsComponentScan(basePackages="org.my.pkg").
        Returns:
        the base packages to scan
        Default:
        {}
      • basePackages

        @AliasFor("value")
        java.lang.String[] basePackages
        Base packages to scan for entities. value() is an alias for (and mutually exclusive with) this attribute.

        Use basePackageClasses() for a type-safe alternative to String-based package names.

        Returns:
        the base packages to scan
        Default:
        {}
      • basePackageClasses

        java.lang.Class<?>[] basePackageClasses
        Type-safe alternative to basePackages() for specifying the packages to scan for entities. The package of each class specified will be scanned.

        Consider creating a special no-op marker class or interface in each package that serves no purpose other than being referenced by this attribute.

        Returns:
        classes from the base packages to scan
        Default:
        {}