|
45 | 45 | * annotation declarations e.g.: |
46 | 46 | * {@code @EnableDynamoDBRepositories("org.my.pkg")} instead of |
47 | 47 | * {@code @EnableDynamoDBaRepositories(basePackages="org.my.pkg")}. |
| 48 | + * @return The package name for scanning |
48 | 49 | */ |
49 | 50 | String[] value() default {}; |
50 | 51 |
|
|
53 | 54 | * alias for (and mutually exclusive with) this attribute. Use |
54 | 55 | * {@link #basePackageClasses()} for a type-safe alternative to String-based |
55 | 56 | * package names. |
| 57 | + * @return The package name for scanning |
56 | 58 | */ |
57 | 59 | String[] basePackages() default {}; |
58 | 60 |
|
|
62 | 64 | * specified will be scanned. Consider creating a special no-op marker class |
63 | 65 | * or interface in each package that serves no purpose other than being |
64 | 66 | * referenced by this attribute. |
| 67 | + * @return The class to figure out the base package for scanning |
65 | 68 | */ |
66 | 69 | Class<?>[] basePackageClasses() default {}; |
67 | 70 |
|
|
70 | 73 | * narrows the set of candidate components from everything in |
71 | 74 | * {@link #basePackages()} to everything in the base packages that matches |
72 | 75 | * the given filter or filters. |
| 76 | + * @return All the include filters |
73 | 77 | */ |
74 | 78 | Filter[] includeFilters() default {}; |
75 | 79 |
|
76 | 80 | /** |
77 | 81 | * Specifies which types are not eligible for component scanning. |
| 82 | + * @return All the exclude filters |
78 | 83 | */ |
79 | 84 | Filter[] excludeFilters() default {}; |
80 | 85 |
|
81 | 86 | /** |
82 | 87 | * Returns the postfix to be used when looking up custom repository |
83 | 88 | * implementations. Defaults to {@literal Impl}. So for a repository named |
84 | 89 | * {@code PersonRepository} the corresponding implementation class will be |
85 | | - * looked up scanning for {@code PersonRepositoryImpl}. |
| 90 | + * looked up scanning for {@code PersonRepositoryImpl}. Defaults to 'Impl'. |
86 | 91 | * |
87 | | - * @return |
| 92 | + * @return The implementation postfix that's used |
88 | 93 | */ |
89 | 94 | String repositoryImplementationPostfix() default "Impl"; |
90 | 95 |
|
|
93 | 98 | * properties file. Will default to |
94 | 99 | * {@code META-INFO/jpa-named-queries.properties}. |
95 | 100 | * |
96 | | - * @return |
| 101 | + * @return The location itself |
97 | 102 | */ |
98 | 103 | String namedQueriesLocation() default ""; |
99 | 104 |
|
100 | 105 | /** |
101 | 106 | * Returns the key of the {@link org.springframework.data.repository.query.QueryLookupStrategy} to be used for lookup |
102 | 107 | * queries for query methods. Defaults to {@link Key#CREATE_IF_NOT_FOUND}. |
103 | 108 | * |
104 | | - * @return |
| 109 | + * @return The lookup strategy |
105 | 110 | */ |
106 | 111 | Key queryLookupStrategy() default Key.CREATE_IF_NOT_FOUND; |
107 | 112 |
|
108 | 113 | /** |
109 | 114 | * Returns the {@link org.springframework.beans.factory.FactoryBean} class to be used for each repository |
110 | 115 | * instance. Defaults to {@link DynamoDBRepositoryFactoryBean}. |
111 | 116 | * |
112 | | - * @return |
| 117 | + * @return The repository factory bean cleass |
113 | 118 | */ |
114 | 119 | Class<?> repositoryFactoryBeanClass() default DynamoDBRepositoryFactoryBean.class; |
115 | 120 |
|
116 | | - // DynamoDB sepcific configuration |
| 121 | + // DynamoDB specific configuration |
117 | 122 |
|
118 | 123 | /** |
119 | 124 | * Returns the {@link com.amazonaws.services.dynamodbv2.AmazonDynamoDB } reference to be used for each |
120 | 125 | * repository instance |
121 | 126 | * |
122 | | - * @return |
| 127 | + * @return The {@link com.amazonaws.services.dynamodbv2.AmazonDynamoDB} bean name |
123 | 128 | */ |
124 | 129 | String amazonDynamoDBRef() default ""; |
125 | 130 |
|
126 | 131 | /** |
127 | 132 | * Returns the {@link com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBMapperConfig } reference to be used for to |
128 | 133 | * configure AmazonDynamoDB |
129 | 134 | * |
130 | | - * @return |
| 135 | + * @return The {@link com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBMapperConfig} bean name |
131 | 136 | */ |
132 | 137 | String dynamoDBMapperConfigRef() default ""; |
133 | 138 |
|
134 | 139 | /** |
135 | 140 | * Returns the {@link javax.validation.Validator } reference to be used for to |
136 | 141 | * validate DynamoDB entities |
137 | 142 | * |
138 | | - * @return |
| 143 | + * @return The {@link org.socialsignin.spring.data.dynamodb.core.DynamoDBOperations} bean name |
139 | 144 | */ |
140 | 145 | String dynamoDBOperationsRef() default ""; |
141 | 146 |
|
|
0 commit comments