Skip to content

Commit 7d0deb4

Browse files
authored
Fix javadoc. (#1283)
Closes #1282. Co-authored-by: mikereiche <[email protected]>
1 parent 495ac13 commit 7d0deb4

33 files changed

+44
-66
lines changed

src/main/java/org/springframework/data/couchbase/cache/CouchbaseCacheConfiguration.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ public static CouchbaseCacheConfiguration defaultCacheConfig() {
6464
* <ul>
6565
* <li>{@link String} to {@link byte byte[]} using UTF-8 encoding.</li>
6666
* <li>{@link SimpleKey} to {@link String}</li>
67-
*
67+
* </ul>
6868
* @param registry must not be {@literal null}.
6969
*/
7070
public static void registerDefaultConverters(final ConverterRegistry registry) {

src/main/java/org/springframework/data/couchbase/cache/CouchbaseCacheManager.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ public CouchbaseCacheManagerBuilder withCacheConfiguration(String cacheName,
228228

229229
/**
230230
* Disable in-flight {@link org.springframework.cache.Cache} creation for unconfigured caches.
231-
* <p />
231+
* <p>
232232
* {@link CouchbaseCacheManager#getMissingCache(String)} returns {@literal null} for any unconfigured
233233
* {@link org.springframework.cache.Cache} instead of a new {@link CouchbaseCache} instance. This allows eg.
234234
* {@link org.springframework.cache.support.CompositeCacheManager} to chime in.

src/main/java/org/springframework/data/couchbase/config/AbstractCouchbaseConfiguration.java

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -254,8 +254,6 @@ public String typeKey() {
254254

255255
/**
256256
* Creates a {@link MappingCouchbaseConverter} using the configured {@link #couchbaseMappingContext}.
257-
*
258-
* @throws Exception on Bean construction failure.
259257
*/
260258
@Bean
261259
public MappingCouchbaseConverter mappingCouchbaseConverter(CouchbaseMappingContext couchbaseMappingContext,
@@ -283,7 +281,6 @@ public TranslationService couchbaseTranslationService() {
283281
/**
284282
* Creates a {@link CouchbaseMappingContext} equipped with entity classes scanned from the mapping base package.
285283
*
286-
* @throws Exception on Bean construction failure.
287284
*/
288285
@Bean
289286
public CouchbaseMappingContext couchbaseMappingContext(CustomConversions customConversions) throws Exception {
@@ -299,7 +296,6 @@ public CouchbaseMappingContext couchbaseMappingContext(CustomConversions customC
299296
/**
300297
* Creates a {@link ObjectMapper} for the jsonSerializer of the ClusterEnvironment
301298
*
302-
* @throws Exception on Bean construction failure.
303299
* @return ObjectMapper
304300
*/
305301

@@ -337,11 +333,9 @@ public CustomConversions customConversions() {
337333
/**
338334
* Return the base package to scan for mapped {@link Document}s. Will return the package name of the configuration
339335
* class (the concrete class, not this one here) by default.
340-
* <p/>
341336
* <p>
342337
* So if you have a {@code com.acme.AppConfig} extending {@link AbstractCouchbaseConfiguration} the base package will
343338
* be considered {@code com.acme} unless the method is overridden to implement alternate behavior.
344-
* </p>
345339
*
346340
* @return the base package to scan for mapped {@link Document} classes or {@literal null} to not enable scanning for
347341
* entities.

src/main/java/org/springframework/data/couchbase/core/CouchbaseExceptionTranslator.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333

3434
/**
3535
* Simple {@link PersistenceExceptionTranslator} for Couchbase.
36-
* <p/>
36+
* <p>
3737
* Convert the given runtime exception to an appropriate exception from the {@code org.springframework.dao} hierarchy.
3838
* Return {@literal null} if no translation is appropriate: any other exception may have resulted from user code, and
3939
* should not be translated.

src/main/java/org/springframework/data/couchbase/core/convert/CouchbaseCustomConversions.java

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,9 @@
2424

2525
/**
2626
* Value object to capture custom conversion.
27-
* <p/>
2827
* <p>
2928
* Types that can be mapped directly onto JSON are considered simple ones, because they neither need deeper inspection
3029
* nor nested conversion.
31-
* </p>
3230
*
3331
* @author Michael Nitschinger
3432
* @author Oliver Gierke

src/main/java/org/springframework/data/couchbase/core/convert/CustomConversions.java

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,9 @@
2020

2121
/**
2222
* Value object to capture custom conversion.
23-
* <p/>
2423
* <p>
2524
* Types that can be mapped directly onto JSON are considered simple ones, because they neither need deeper inspection
2625
* nor nested conversion.
27-
* </p>
2826
*
2927
* @author Michael Nitschinger
3028
* @author Oliver Gierke

src/main/java/org/springframework/data/couchbase/core/convert/MappingCouchbaseConverter.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -816,7 +816,7 @@ public void setApplicationContext(ApplicationContext applicationContext) {
816816
/**
817817
* COPIED Set the {@link EntityCallbacks} instance to use when invoking
818818
* {@link org.springframework.data.mapping.callback.EntityCallback callbacks} like the {@link AfterConvertCallback}.
819-
* <p/>
819+
* <p>
820820
* Overrides potentially existing {@link EntityCallbacks}.
821821
*
822822
* @param entityCallbacks must not be {@literal null}.

src/main/java/org/springframework/data/couchbase/core/mapping/BasicCouchbasePersistentProperty.java

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,9 @@
3232

3333
/**
3434
* Implements annotated property representations of a given {@link Field} instance.
35-
* <p/>
3635
* <p>
3736
* This object is used to gather information out of properties on objects that need to be persisted. For example, it
3837
* supports overriding of the actual property name by providing custom annotations.
39-
* </p>
4038
*
4139
* @author Michael Nitschinger
4240
* @author Mark Paluch
@@ -71,7 +69,7 @@ protected Association<CouchbasePersistentProperty> createAssociation() {
7169

7270
/**
7371
* Returns the field name of the property.
74-
* <p/>
72+
* <p>
7573
* The field name can be different from the actual property name by using a custom annotation.
7674
*/
7775
@Override

src/main/java/org/springframework/data/couchbase/core/mapping/CouchbaseDocument.java

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -23,18 +23,14 @@
2323

2424
/**
2525
* A {@link CouchbaseDocument} is an abstract representation of a document stored inside Couchbase Server.
26-
* <p/>
2726
* <p>
2827
* It acts like a {@link HashMap}, but only allows those types to be written that are supported by the underlying
2928
* storage format, which is currently JSON. Note that JSON conversion is not happening here, but performed at a
3029
* different stage based on the payload stored in the {@link CouchbaseDocument}.
31-
* </p>
32-
* <p/>
3330
* <p>
3431
* In addition to the actual content, meta data is also stored. This especially refers to the document ID and its
3532
* expiration time. Note that this information is not mandatory, since documents can be nested and therefore only the
3633
* topmost document most likely has an ID.
37-
* </p>
3834
*
3935
* @author Michael Nitschinger
4036
*/
@@ -114,7 +110,7 @@ public final Object get(final String key) {
114110

115111
/**
116112
* Returns the current payload, including all recursive elements.
117-
* <p/>
113+
* <p>
118114
* It either returns the raw results or makes sure that the recusrive elements are also exported properly.
119115
*
120116
* @return
@@ -187,10 +183,8 @@ public final int size(final boolean recursive) {
187183

188184
/**
189185
* Returns the underlying payload.
190-
* <p/>
191186
* <p>
192187
* Note that unlike {@link #export()}, the nested objects are not converted, so the "raw" map is returned.
193-
* </p>
194188
*
195189
* @return the underlying payload.
196190
*/
@@ -221,7 +215,7 @@ public CouchbaseDocument setContent(final JsonObject payload) {
221215

222216
/**
223217
* Returns the expiration time of the document.
224-
* <p/>
218+
* <p>
225219
* If the expiration time is 0, then the document will be persisted until deleted manually ("forever").
226220
*
227221
* @return the expiration time of the document.
@@ -232,9 +226,9 @@ public int getExpiration() {
232226

233227
/**
234228
* Set the expiration time of the document.
235-
* <p/>
229+
* <p>
236230
* If the expiration time is 0, then the document will be persisted until deleted manually ("forever").
237-
* <p/>
231+
* <p>
238232
* Expiration should be expressed as seconds if <= 30 days (30 x 24 x 60 x 60 seconds), or as an expiry date (UTC,
239233
* UNIX time ie. seconds form the Epoch) if > 30 days.
240234
*

src/main/java/org/springframework/data/couchbase/core/mapping/CouchbaseList.java

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,9 @@
2525

2626
/**
2727
* A {@link CouchbaseList} is an abstract list that represents an array stored in a (most of the times JSON) document.
28-
* <p/>
2928
* <p>
3029
* This {@link CouchbaseList} is part of the potentially nested structure inside one or more {@link CouchbaseDocument}s.
3130
* It can also contain them recursively, depending on how the document is modeled.
32-
* </p>
3331
*/
3432
public class CouchbaseList implements CouchbaseStorable {
3533

@@ -145,7 +143,7 @@ public final int size(final boolean recursive) {
145143

146144
/**
147145
* Returns the current payload, including all recursive elements.
148-
* <p/>
146+
* <p>
149147
* It either returns the raw results or makes sure that the recusrive elements are also exported properly.
150148
*
151149
* @return

0 commit comments

Comments
 (0)