Annotation Interface EnableMeilisearchRepositories
@Target(TYPE)
@Retention(RUNTIME)
@Documented
@Inherited
@Import(io.vanslog.spring.data.meilisearch.repository.config.MeilisearchRepositoriesRegistrar.class)
public @interface EnableMeilisearchRepositories
Annotation to enable Meilisearch repositories.
AnnotationRepositoryConfigurationSource will scan the package of
the annotated configuration class for Spring Data repositories by default.- Author:
- Junghoon Ban
-
Optional Element Summary
Optional ElementsModifier and TypeOptional ElementDescriptionClass<?>[]Type-safe alternative tobasePackages()for specifying the packages to scan for annotated components.String[]Base packages to scan for annotated components.booleanConfigures whether nested repository-interfaces (e.g. defined as inner classes) should be discovered by the repositories infrastructure.Specifies which types are not eligible for component scanning.Specifies which types are eligible for component scanning.Returns theMeilisearchTemplatebean name.Configures the location of where to find the Spring Data named queries properties file.Returns the key of theQueryLookupStrategyto be used for lookup queries for query methods.Class<?>Returns theFactoryBeanclass to be used for each repository instance.Returns the postfix to be used when looking up custom repository implementations.String[]Alias for thebasePackages()attribute.
-
Element Details
-
value
String[] valueAlias for thebasePackages()attribute. Allows for more concise annotation declarations e.g.:@EnableMeilisearchRepositories("org.my.pkg")instead of@EnableMeilisearchRepositories(basePackages="org.my.pkg").- Returns:
- String[]
- Default:
- {}
-
basePackages
String[] basePackagesBase packages to scan for annotated components.value()is an alias for (and mutually exclusive with) this attribute. UsebasePackageClasses()for a type-safe alternative to text-based package names.- Returns:
- String[]
- Default:
- {}
-
basePackageClasses
Class<?>[] basePackageClassesType-safe alternative tobasePackages()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.- Returns:
- Class<?>[]
- Default:
- {}
-
includeFilters
ComponentScan.Filter[] includeFiltersSpecifies which types are eligible for component scanning. Further narrows the set of candidate components from everything inbasePackages()to everything in the base packages that matches the given filter or filters.- Returns:
- Filter[]
- Default:
- {}
-
excludeFilters
ComponentScan.Filter[] excludeFiltersSpecifies which types are not eligible for component scanning.- Returns:
- Filter[]
- Default:
- {}
-
repositoryImplementationPostfix
String repositoryImplementationPostfixReturns the postfix to be used when looking up custom repository implementations. Defaults to Impl. So for a repository namedPersonRepositorythe corresponding implementation class will be looked up scanning forPersonRepositoryImpl.- Returns:
- String
- Default:
- "Impl"
-
namedQueriesLocation
String namedQueriesLocationConfigures the location of where to find the Spring Data named queries properties file.- Returns:
- String
- Default:
- ""
-
queryLookupStrategy
QueryLookupStrategy.Key queryLookupStrategyReturns the key of theQueryLookupStrategyto be used for lookup queries for query methods. Defaults toQueryLookupStrategy.Key.CREATE_IF_NOT_FOUND.- Returns:
- Key
- Default:
- CREATE_IF_NOT_FOUND
-
repositoryFactoryBeanClass
Class<?> repositoryFactoryBeanClassReturns theFactoryBeanclass to be used for each repository instance. Defaults toMeilisearchRepositoryFactoryBean.- Returns:
- Class<?>[]
- Default:
- io.vanslog.spring.data.meilisearch.repository.support.MeilisearchRepositoryFactoryBean.class
-
meilisearchTemplateRef
String meilisearchTemplateRefReturns theMeilisearchTemplatebean name. This name will be used to create Meilisearch repositories discovered through this annotation. Defaults tomeilisearchTemplate.- Returns:
- String
- Default:
- "meilisearchTemplate"
-
considerNestedRepositories
boolean considerNestedRepositoriesConfigures whether nested repository-interfaces (e.g. defined as inner classes) should be discovered by the repositories infrastructure.- Returns:
- boolean
- Default:
- false
-