Package org.springframework.shell.command.annotation

Annotation Interface CommandScan

@Target(TYPE) @Retention(RUNTIME) @Documented @Import(CommandScanRegistrar.class) @EnableCommand public @interface CommandScan
Configures the base packages used when scanning for @Comamnd classes. 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.

  • Element Details

    • value

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

    • basePackages

      @AliasFor("value") String[] basePackages
      Base packages to scan for commands. 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

      Class<?>[] basePackageClasses
      Type-safe alternative to basePackages() for specifying the packages to scan for commands. 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:
      {}