Package org.springframework.data.map.repository.config

Annotation Interface EnableMapRepositories

@Target(TYPE) @Retention(RUNTIME) @Documented @Inherited @Import(MapRepositoriesRegistrar.class) @QueryCreatorType(PredicateQueryCreator.class) public @interface EnableMapRepositories
Annotation to activate Map repositories. If no base package is configured through either value(), basePackages() or basePackageClasses() it will trigger scanning of the package of annotated class.
Author:
Christoph Strobl, Oliver Gierke, Mark Paluch

  • Element Details

    • value

      String[] value
      Alias for the basePackages() attribute. Allows for more concise annotation declarations e.g.: @EnableJpaRepositories("org.my.pkg") instead of @EnableJpaRepositories(basePackages="org.my.pkg").
      Default:
      {}

    • basePackages

      String[] basePackages
      Base packages to scan for annotated components. value() is an alias for (and mutually exclusive with) this attribute. Use basePackageClasses() for a type-safe alternative to String-based package names.
      Default:
      {}

    • basePackageClasses

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

    • excludeFilters

      ComponentScan.Filter[] excludeFilters
      Specifies which types are not eligible for component scanning.
      Default:
      {}

    • includeFilters

      ComponentScan.Filter[] includeFilters
      Specifies which types are eligible for component scanning. Further narrows the set of candidate components from everything in basePackages() to everything in the base packages that matches the given filter or filters.
      Default:
      {}

    • repositoryImplementationPostfix

      String repositoryImplementationPostfix
      Returns the postfix to be used when looking up custom repository implementations. Defaults to Impl. So for a repository named PersonRepository the corresponding implementation class will be looked up scanning for PersonRepositoryImpl.
      Returns:
      Default:
      "Impl"

    • namedQueriesLocation

      String namedQueriesLocation
      Configures the location of where to find the Spring Data named queries properties file.
      Returns:
      Default:
      ""

    • queryLookupStrategy

      QueryLookupStrategy.Key queryLookupStrategy
      Returns the key of the QueryLookupStrategy to be used for lookup queries for query methods. Defaults to QueryLookupStrategy.Key.CREATE_IF_NOT_FOUND.
      Returns:
      Default:
      CREATE_IF_NOT_FOUND

    • repositoryFactoryBeanClass

      Class<?> repositoryFactoryBeanClass
      Returns the FactoryBean class to be used for each repository instance. Defaults to KeyValueRepositoryFactoryBean.
      Returns:
      Default:
      org.springframework.data.keyvalue.repository.support.KeyValueRepositoryFactoryBean.class

    • repositoryBaseClass

      Class<?> repositoryBaseClass
      Configure the repository base class to be used to create repository proxies for this particular configuration.
      Returns:
      Default:
      org.springframework.data.repository.config.DefaultRepositoryBaseClass.class

    • keyValueTemplateRef

      String keyValueTemplateRef
      Configures the name of the KeyValueOperations bean to be used with the repositories detected.
      Returns:
      Default:
      "mapKeyValueTemplate"

    • considerNestedRepositories

      boolean considerNestedRepositories
      Configures whether nested repository-interfaces (e.g. defined as inner classes) should be discovered by the repositories infrastructure.
      Default:
      false

    • mapType

      Class<? extends Map> mapType
      Configures the Map structure used for data storage. Defaults to ConcurrentHashMap. Will be ignored in case an explicit bean for the KeyValueTemplate is available in the ApplicationContext.
      See Also:
      Default:
      java.util.concurrent.ConcurrentHashMap.class

    • queryEngineFactory

      Class<? extends QueryEngineFactory> queryEngineFactory
      Configures the QueryEngineFactory to create the QueryEngine. When both, the query engine and sort accessors are configured, the query engine is instantiated using the configured sort accessor.
      Returns:
      QueryEngineFactory to configure the QueryEngine.
      Since:
      3.3.1
      Default:
      org.springframework.data.keyvalue.core.QueryEngineFactory.class

    • queryCreator

      @AliasFor(annotation=QueryCreatorType.class, value="value") Class<? extends AbstractQueryCreator<?,?>> queryCreator
      Configures the QueryCreator to create Part-Tree queries. The QueryCreator must create queries supported by the underlying QueryEngine.
      Returns:
      AbstractQueryCreator
      Since:
      3.3.1
      Default:
      org.springframework.data.keyvalue.repository.query.PredicateQueryCreator.class

    • sortAccessor

      Class<? extends SortAccessor> sortAccessor
      Configures the accessor for sorting results.
      Returns:
      the configured SortAccessor.
      Since:
      3.1.10
      Default:
      org.springframework.data.keyvalue.core.SortAccessor.class