Skip to content

Commit 1380782

Browse files
committed
Document placeholder and Ant-style pattern support for @Enable…Repositories.
See spring-projects/spring-data-commons#3366
1 parent 948c661 commit 1380782

File tree

2 files changed

+30
-6
lines changed

2 files changed

+30
-6
lines changed

spring-data-cassandra/src/main/java/org/springframework/data/cassandra/repository/config/EnableCassandraRepositories.java

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,20 @@
5656
String[] value() default {};
5757

5858
/**
59-
* Base packages to scan for annotated components. {@link #value()} is an alias for (and mutually exclusive with) this
60-
* attribute. Use {@link #basePackageClasses()} for a type-safe alternative to String-based package names.
59+
* Base packages to scan for annotated components.
60+
* <p>
61+
* {@link #value} is an alias for (and mutually exclusive with) this attribute.
62+
* <p>
63+
* Supports {@code ${…}} placeholders which are resolved against the {@link org.springframework.core.env.Environment
64+
* Environment} as well as Ant-style package patterns &mdash; for example, {@code "org.example.**"}.
65+
* <p>
66+
* Multiple packages or patterns may be specified, either separately or within a single {@code String} &mdash; for
67+
* example, {@code {"org.example.config", "org.example.service.**"}} or
68+
* {@code "org.example.config, org.example.service.**"}.
69+
* <p>
70+
* Use {@link #basePackageClasses} for a type-safe alternative to String-based package names.
71+
*
72+
* @see org.springframework.context.ConfigurableApplicationContext#CONFIG_LOCATION_DELIMITERS
6173
*/
6274
String[] basePackages() default {};
6375

spring-data-cassandra/src/main/java/org/springframework/data/cassandra/repository/config/EnableReactiveCassandraRepositories.java

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,14 +49,26 @@
4949

5050
/**
5151
* Alias for the {@link #basePackages()} attribute. Allows for more concise annotation declarations e.g.:
52-
* {@code @EnableCassandraRepositories("org.my.pkg")} instead of
53-
* {@code @EnableCassandraRepositories(basePackages="org.my.pkg")}.
52+
* {@code @EnableReactiveCassandraRepositories("org.my.pkg")} instead of
53+
* {@code @EnableReactiveCassandraRepositories(basePackages="org.my.pkg")}.
5454
*/
5555
String[] value() default {};
5656

5757
/**
58-
* Base packages to scan for annotated components. {@link #value()} is an alias for (and mutually exclusive with) this
59-
* attribute. Use {@link #basePackageClasses()} for a type-safe alternative to String-based package names.
58+
* Base packages to scan for annotated components.
59+
* <p>
60+
* {@link #value} is an alias for (and mutually exclusive with) this attribute.
61+
* <p>
62+
* Supports {@code ${…}} placeholders which are resolved against the {@link org.springframework.core.env.Environment
63+
* Environment} as well as Ant-style package patterns &mdash; for example, {@code "org.example.**"}.
64+
* <p>
65+
* Multiple packages or patterns may be specified, either separately or within a single {@code String} &mdash; for
66+
* example, {@code {"org.example.config", "org.example.service.**"}} or
67+
* {@code "org.example.config, org.example.service.**"}.
68+
* <p>
69+
* Use {@link #basePackageClasses} for a type-safe alternative to String-based package names.
70+
*
71+
* @see org.springframework.context.ConfigurableApplicationContext#CONFIG_LOCATION_DELIMITERS
6072
*/
6173
String[] basePackages() default {};
6274

0 commit comments

Comments
 (0)