Skip to content

Commit 88128e5

Browse files
committed
Polishing.
Fix Javadoc formatting. Consistently mention proxy class unwrapping. Original pull request: #2406.
1 parent 0d92abc commit 88128e5

File tree

1 file changed

+22
-9
lines changed

1 file changed

+22
-9
lines changed

src/main/java/org/springframework/data/repository/support/Repositories.java

+22-9
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,8 @@ private synchronized void cacheRepositoryFactory(String name) {
118118
}
119119

120120
/**
121-
* Returns whether we have a repository instance registered to manage instances of the given domain class.
121+
* Returns whether we have a repository instance registered to manage instances of the given domain class. The given
122+
* {@code domainClass} is unwrapped to the actual user class if necessary.
122123
*
123124
* @param domainClass must not be {@literal null}.
124125
* @return
@@ -133,7 +134,8 @@ public boolean hasRepositoryFor(Class<?> domainClass) {
133134
}
134135

135136
/**
136-
* Returns the repository managing the given domain class.
137+
* Returns the repository managing the given domain class. The given {@code domainClass} is unwrapped to the actual
138+
* user class if necessary.
137139
*
138140
* @param domainClass must not be {@literal null}.
139141
* @return
@@ -149,12 +151,13 @@ public Optional<Object> getRepositoryFor(Class<?> domainClass) {
149151
}
150152

151153
/**
152-
* Returns the {@link RepositoryFactoryInformation} for the given domain class. The given <code>code</code> is
153-
* converted to the actual user class if necessary, @see ProxyUtils#getUserClass.
154+
* Returns the {@link RepositoryFactoryInformation} for the given domain class. The given {@code domainClass} is
155+
* unwrapped to the actual user class if necessary.
154156
*
155157
* @param domainClass must not be {@literal null}.
156158
* @return the {@link RepositoryFactoryInformation} for the given domain class or {@literal null} if no repository
157159
* registered for this domain class.
160+
* @see ProxyUtils#getUserClass
158161
*/
159162
private RepositoryFactoryInformation<Object, Object> getRepositoryFactoryInfoFor(Class<?> domainClass) {
160163

@@ -175,10 +178,12 @@ private RepositoryFactoryInformation<Object, Object> getRepositoryFactoryInfoFor
175178
}
176179

177180
/**
178-
* Returns the {@link EntityInformation} for the given domain class.
181+
* Returns the {@link EntityInformation} for the given domain class. The given {@code domainClass} is unwrapped to the
182+
* actual user class if necessary.
179183
*
180184
* @param domainClass must not be {@literal null}.
181185
* @return
186+
* @see ProxyUtils#getUserClass
182187
*/
183188
@SuppressWarnings("unchecked")
184189
public <T, S> EntityInformation<T, S> getEntityInformationFor(Class<?> domainClass) {
@@ -189,11 +194,13 @@ public <T, S> EntityInformation<T, S> getEntityInformationFor(Class<?> domainCla
189194
}
190195

191196
/**
192-
* Returns the {@link RepositoryInformation} for the given domain class.
197+
* Returns the {@link RepositoryInformation} for the given domain class. The given {@code domainClass} is unwrapped to
198+
* the actual user class if necessary.
193199
*
194200
* @param domainClass must not be {@literal null}.
195201
* @return the {@link RepositoryInformation} for the given domain class or {@literal Optional#empty()} if no
196202
* repository registered for this domain class.
203+
* @see ProxyUtils#getUserClass
197204
*/
198205
public Optional<RepositoryInformation> getRepositoryInformationFor(Class<?> domainClass) {
199206

@@ -205,11 +212,13 @@ public Optional<RepositoryInformation> getRepositoryInformationFor(Class<?> doma
205212
}
206213

207214
/**
208-
* Returns the {@link RepositoryInformation} for the given domain type.
215+
* Returns the {@link RepositoryInformation} for the given domain type. The given {@code domainType} is unwrapped to
216+
* the actual user class if necessary.
209217
*
210218
* @param domainType must not be {@literal null}.
211219
* @return the {@link RepositoryInformation} for the given domain type.
212220
* @throws IllegalArgumentException in case no {@link RepositoryInformation} could be found for the given domain type.
221+
* @see ProxyUtils#getUserClass
213222
*/
214223
public RepositoryInformation getRequiredRepositoryInformation(Class<?> domainType) {
215224

@@ -235,11 +244,13 @@ public Optional<RepositoryInformation> getRepositoryInformation(Class<?> reposit
235244

236245
/**
237246
* Returns the {@link PersistentEntity} for the given domain class. Might return {@literal null} in case the module
238-
* storing the given domain class does not support the mapping subsystem.
247+
* storing the given domain class does not support the mapping subsystem. The given {@code domainClass} is unwrapped
248+
* to the actual user class if necessary.
239249
*
240250
* @param domainClass must not be {@literal null}.
241251
* @return the {@link PersistentEntity} for the given domain class or {@literal null} if no repository is registered
242252
* for the domain class or the repository is not backed by a {@link MappingContext} implementation.
253+
* @see ProxyUtils#getUserClass
243254
*/
244255
public PersistentEntity<?, ?> getPersistentEntity(Class<?> domainClass) {
245256

@@ -248,10 +259,12 @@ public Optional<RepositoryInformation> getRepositoryInformation(Class<?> reposit
248259
}
249260

250261
/**
251-
* Returns the {@link QueryMethod}s contained in the repository managing the given domain class.
262+
* Returns the {@link QueryMethod}s contained in the repository managing the given domain class. The given
263+
* {@code domainClass} is unwrapped to the actual user class if necessary.
252264
*
253265
* @param domainClass must not be {@literal null}.
254266
* @return
267+
* @see ProxyUtils#getUserClass
255268
*/
256269
public List<QueryMethod> getQueryMethodsFor(Class<?> domainClass) {
257270

0 commit comments

Comments
 (0)