Skip to content

Commit d6dc3a0

Browse files
committed
Fix malformed Javadoc.
See #1171
1 parent 05cb997 commit d6dc3a0

File tree

69 files changed

+164
-168
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

69 files changed

+164
-168
lines changed

spring-data-cassandra/src/main/java/org/springframework/data/cassandra/ReactiveSession.java

+12-12
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,11 @@
3535
* A session holds connections to a Cassandra cluster, allowing it to be queried. {@link ReactiveSession} executes
3636
* queries and prepares statements in a reactive style returning results wrapped in {@link Mono} and
3737
* {@link reactor.core.publisher.Flux}.
38-
* <p/>
38+
* <p>
3939
* Each session maintains multiple connections to the cluster nodes, provides policies to choose which node to use for
4040
* each query (round-robin on all nodes of the cluster by default), and handles retries for failed queries (when it
4141
* makes sense).
42-
* <p/>
42+
* <p>
4343
* Session instances are thread-safe and usually a single instance is enough per application. As a given session can
4444
* only be "logged" into one keyspace at a time (where the "logged" keyspace is the one used by queries that don't
4545
* explicitly use a fully qualified table name), it can make sense to create one session per keyspace used. This is
@@ -56,11 +56,11 @@ public interface ReactiveSession extends Closeable {
5656

5757
/**
5858
* Returns a snapshot of the Cassandra cluster's topology and schema metadata.
59-
* <p/>
59+
* <p>
6060
* In order to provide atomic updates, this method returns an immutable object: the node list, token map, and schema
6161
* contained in a given instance will always be consistent with each other (but note that {@link Node} itself is not
6262
* immutable: some of its properties will be updated dynamically, in particular {@link Node#getState()}).
63-
* <p/>
63+
* <p>
6464
* As a consequence of the above, you should call this method each time you need a fresh view of the metadata. <b>Do
6565
* not</b> call it once and store the result, because it is a frozen snapshot that will become stale over time.
6666
* <p>
@@ -76,7 +76,7 @@ public interface ReactiveSession extends Closeable {
7676
/**
7777
* The keyspace that this session is currently connected to, or {@link Optional#empty()} if this session is not
7878
* connected to any keyspace.
79-
* <p/>
79+
* <p>
8080
* There are two ways that this can be set: before initializing the session (either with the {@code session-keyspace}
8181
* option in the configuration, or with {@link CqlSessionBuilder#withKeyspace(CqlIdentifier)}); or at runtime, if the
8282
* client issues a request that changes the keyspace (such as a CQL {@code USE} query). Note that this second method
@@ -90,7 +90,7 @@ public interface ReactiveSession extends Closeable {
9090

9191
/**
9292
* Whether this Session instance has been closed.
93-
* <p/>
93+
* <p>
9494
* Note that this method returns true as soon as the closing of this Session has started but it does not guarantee
9595
* that the closing is done. If you want to guarantee that the closing is done, you can call {@code close()} and wait
9696
* until it returns (or call the get method on {@code closeAsync()} with a very short timeout and check this doesn't
@@ -109,7 +109,7 @@ public interface ReactiveSession extends Closeable {
109109

110110
/**
111111
* Executes the provided query.
112-
* <p/>
112+
* <p>
113113
* This is a convenience method for {@code execute(new SimpleStatement(query))}.
114114
*
115115
* @param query the CQL query to execute.
@@ -120,7 +120,7 @@ public interface ReactiveSession extends Closeable {
120120

121121
/**
122122
* Executes the provided query using the provided values.
123-
* <p/>
123+
* <p>
124124
* This is a convenience method for {@code execute(new SimpleStatement(query, values))}.
125125
*
126126
* @param query the CQL query to execute.
@@ -133,7 +133,7 @@ public interface ReactiveSession extends Closeable {
133133

134134
/**
135135
* Executes the provided query using the provided named values.
136-
* <p/>
136+
* <p>
137137
* This is a convenience method for {@code execute(new SimpleStatement(query, values))}.
138138
*
139139
* @param query the CQL query to execute.
@@ -146,7 +146,7 @@ public interface ReactiveSession extends Closeable {
146146

147147
/**
148148
* Executes the provided query.
149-
* <p/>
149+
* <p>
150150
* This method blocks until at least some result has been received from the database. However, for SELECT queries, it
151151
* does not guarantee that the result has been received in full. But it does guarantee that some response has been
152152
* received from the database, and in particular guarantees that if the request is invalid, an exception will be
@@ -168,7 +168,7 @@ public interface ReactiveSession extends Closeable {
168168

169169
/**
170170
* Prepares the provided query.
171-
* <p/>
171+
* <p>
172172
* This method behaves like {@link #prepare(String)}, but note that the resulting {@code PreparedStatement} will
173173
* inherit the query properties set on {@code statement}. Concretely, this means that in the following code:
174174
*
@@ -180,7 +180,7 @@ public interface ReactiveSession extends Closeable {
180180
* </pre>
181181
*
182182
* the final execution will be performed with Quorum consistency.
183-
* <p/>
183+
* <p>
184184
* Please note that if the same CQL statement is prepared more than once, all calls to this method will return the
185185
* same {@code PreparedStatement} object but the method will still apply the properties of the prepared
186186
* {@code Statement} to this object.

spring-data-cassandra/src/main/java/org/springframework/data/cassandra/ReactiveSessionFactory.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@
3434
public interface ReactiveSessionFactory {
3535

3636
/**
37-
* Return a {@link ReactiveSession} to be used directly or inside a callback inside {@link ReactiveCqlTemplate}.
37+
* Return a {@link ReactiveSession} to be used directly or inside a callback inside
38+
* {@link org.springframework.data.cassandra.core.cql.ReactiveCqlTemplate}.
3839
*
3940
* @return a {@link ReactiveSession}.
4041
*/

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

+3-1
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,14 @@
1616

1717
package org.springframework.data.cassandra.config;
1818

19+
1920
import org.springframework.data.cassandra.core.cql.CassandraExceptionTranslator;
2021
import org.springframework.data.cassandra.core.cql.CqlTemplate;
2122

2223
/**
2324
* Factory for creating and configuring a Cassandra {@link com.datastax.oss.driver.api.core.CqlSession}, which is a
24-
* thread-safe singleton. As such, it is sufficient to have one {@link CqlSession} per application and keyspace.
25+
* thread-safe singleton. As such, it is sufficient to have one {@link com.datastax.oss.driver.api.core.CqlSession} per
26+
* application and keyspace.
2527
*
2628
* @author Alex Shvid
2729
* @author Matthew T. Adams

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ public static void addRequiredPropertyValue(BeanDefinitionBuilder builder, Strin
143143
/**
144144
* Adds the named property and value, or reference to the given {@link BeanDefinitionBuilder} with an optional default
145145
* value if the value has not been specified.
146-
* <p/>
146+
* <p>
147147
* If {@code required} is <code>false</code>, <code>value</code> is null or empty, and {@code defaultValue} is null or
148148
* empty, then no property is added to the bean definition and this method silently returns.
149149
*

spring-data-cassandra/src/main/java/org/springframework/data/cassandra/core/AsyncCassandraTemplate.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ public class AsyncCassandraTemplate
135135
*
136136
* @param session {@link CqlSession} used to interact with Cassandra; must not be {@literal null}.
137137
* @see CassandraConverter
138-
* @see Session
138+
* @see CqlSession
139139
*/
140140
public AsyncCassandraTemplate(CqlSession session) {
141141
this(session, newConverter(session));

spring-data-cassandra/src/main/java/org/springframework/data/cassandra/core/CassandraBatchTemplate.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ class CassandraBatchTemplate implements CassandraBatchOperations {
7272

7373
/**
7474
* Return a reference to the configured {@link CassandraConverter} used to map {@link Object Objects} to
75-
* {@link com.datastax.driver.core.Row Rows}.
75+
* {@link com.datastax.oss.driver.api.core.cql.Row Rows}.
7676
*
7777
* @return a reference to the configured {@link CassandraConverter}.
7878
* @see org.springframework.data.cassandra.core.convert.CassandraConverter

spring-data-cassandra/src/main/java/org/springframework/data/cassandra/core/CassandraOperations.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ public interface CassandraOperations extends FluentCassandraOperations {
9898
/**
9999
* Execute a {@code SELECT} query and convert the resulting items to a {@link Iterator} of entities.
100100
* <p>
101-
* Returns a {@link Iterator} that wraps the Cassandra {@link com.datastax.driver.core.ResultSet}.
101+
* Returns a {@link Iterator} that wraps the Cassandra {@link ResultSet}.
102102
*
103103
* @param <T> element return type.
104104
* @param cql query to execute. Must not be empty or {@literal null}.
@@ -160,7 +160,7 @@ public interface CassandraOperations extends FluentCassandraOperations {
160160
/**
161161
* Execute a {@code SELECT} query and convert the resulting items to a {@link Iterator} of entities.
162162
* <p>
163-
* Returns a {@link Iterator} that wraps the Cassandra {@link com.datastax.driver.core.ResultSet}.
163+
* Returns a {@link Iterator} that wraps the Cassandra {@link ResultSet}.
164164
*
165165
* @param <T> element return type.
166166
* @param statement query to execute. Must not be empty or {@literal null}.
@@ -212,7 +212,7 @@ public interface CassandraOperations extends FluentCassandraOperations {
212212
/**
213213
* Execute a {@code SELECT} query and convert the resulting items to a {@link Iterator} of entities.
214214
* <p>
215-
* Returns a {@link Iterator} that wraps the Cassandra {@link com.datastax.driver.core.ResultSet}.
215+
* Returns a {@link Iterator} that wraps the Cassandra {@link ResultSet}.
216216
*
217217
* @param <T> element return type.
218218
* @param query query to execute. Must not be empty or {@literal null}.

spring-data-cassandra/src/main/java/org/springframework/data/cassandra/core/CassandraPersistentEntitySchemaCreator.java

-1
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,6 @@ public class CassandraPersistentEntitySchemaCreator {
6161
* Create a new {@link CassandraPersistentEntitySchemaCreator} for the given {@link CassandraMappingContext} and
6262
* {@link CassandraAdminOperations}.
6363
*
64-
* @param mappingContext must not be {@literal null}.
6564
* @param cassandraAdminOperations must not be {@literal null}.
6665
* @since 3.0
6766
*/

spring-data-cassandra/src/main/java/org/springframework/data/cassandra/core/CassandraTemplate.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ public class CassandraTemplate implements CassandraOperations, ApplicationEventP
138138
*
139139
* @param session {@link CqlSession} used to interact with Cassandra; must not be {@literal null}.
140140
* @see CassandraConverter
141-
* @see Session
141+
* @see CqlSession
142142
*/
143143
public CassandraTemplate(CqlSession session) {
144144
this(session, newConverter(session));
@@ -152,7 +152,7 @@ public CassandraTemplate(CqlSession session) {
152152
* @param converter {@link CassandraConverter} used to convert between Java and Cassandra types; must not be
153153
* {@literal null}.
154154
* @see CassandraConverter
155-
* @see Session
155+
* @see CqlSession
156156
*/
157157
public CassandraTemplate(CqlSession session, CassandraConverter converter) {
158158
this(new DefaultSessionFactory(session), converter);
@@ -180,7 +180,7 @@ public CassandraTemplate(SessionFactory sessionFactory, CassandraConverter conve
180180
* @param converter {@link CassandraConverter} used to convert between Java and Cassandra types; must not be
181181
* {@literal null}.
182182
* @see CassandraConverter
183-
* @see Session
183+
* @see CqlSession
184184
*/
185185
public CassandraTemplate(CqlOperations cqlOperations, CassandraConverter converter) {
186186

spring-data-cassandra/src/main/java/org/springframework/data/cassandra/core/ExecutableSelectOperation.java

+4-3
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,15 @@
2424
import org.springframework.util.Assert;
2525

2626
import com.datastax.oss.driver.api.core.CqlIdentifier;
27+
import com.datastax.oss.driver.api.core.cql.ResultSet;
2728

2829
/**
2930
* The {@link ExecutableSelectOperation} interface allows creation and execution of Cassandra {@code SELECT} operations
3031
* in a fluent API style.
3132
* <p>
3233
* The starting {@literal domainType} is used for mapping the {@link Query} provided via {@code matching} into the
3334
* Cassandra-specific representation. By default, the originating {@literal domainType} is also used for mapping back
34-
* the result from the {@link com.datastax.driver.core.Row}. However, it is possible to define an different
35+
* the result from the {@link com.datastax.oss.driver.api.core.cql.Row}. However, it is possible to define an different
3536
* {@literal returnType} via {@code as} for mapping the result.
3637
* <p>
3738
* By default, the table to operate on is derived from the initial {@literal domainType} and can be defined there with
@@ -212,8 +213,8 @@ default Optional<T> one() {
212213
/**
213214
* Stream all matching elements.
214215
*
215-
* @return a {@link Stream} wrapping the Cassandra {@link com.datastax.driver.core.ResultSet}, which needs to be
216-
* closed; never {@literal null}.
216+
* @return a {@link Stream} wrapping the Cassandra {@link ResultSet}, which needs to be closed; never
217+
* {@literal null}.
217218
* @see java.util.stream.Stream
218219
* @see #all()
219220
*/

spring-data-cassandra/src/main/java/org/springframework/data/cassandra/core/ReactiveCassandraBatchTemplate.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ private void assertNotExecuted() {
8585

8686
/**
8787
* Return a reference to the configured {@link CassandraConverter} used to map {@link Object Objects} to
88-
* {@link com.datastax.driver.core.Row Rows}.
88+
* {@link com.datastax.oss.driver.api.core.cql.Row Rows}.
8989
*
9090
* @return a reference to the configured {@link CassandraConverter}.
9191
* @see org.springframework.data.cassandra.core.convert.CassandraConverter

spring-data-cassandra/src/main/java/org/springframework/data/cassandra/core/ReactiveCassandraTemplate.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ public class ReactiveCassandraTemplate
134134
*
135135
* @param session {@link ReactiveSession} used to interact with Cassandra; must not be {@literal null}.
136136
* @see CassandraConverter
137-
* @see Session
137+
* @see ReactiveSession
138138
*/
139139
public ReactiveCassandraTemplate(ReactiveSession session) {
140140
this(session, newConverter(session));
@@ -148,7 +148,7 @@ public ReactiveCassandraTemplate(ReactiveSession session) {
148148
* @param converter {@link CassandraConverter} used to convert between Java and Cassandra types; must not be
149149
* {@literal null}.
150150
* @see org.springframework.data.cassandra.core.convert.CassandraConverter
151-
* @see com.datastax.oss.driver.api.core.CqlSession
151+
* @see ReactiveSession
152152
*/
153153
public ReactiveCassandraTemplate(ReactiveSession session, CassandraConverter converter) {
154154
this(new DefaultReactiveSessionFactory(session), converter);
@@ -162,7 +162,7 @@ public ReactiveCassandraTemplate(ReactiveSession session, CassandraConverter con
162162
* @param converter {@link CassandraConverter} used to convert between Java and Cassandra types; must not be
163163
* {@literal null}.
164164
* @see org.springframework.data.cassandra.core.convert.CassandraConverter
165-
* @see com.datastax.oss.driver.api.core.CqlSession
165+
* @see ReactiveSession
166166
*/
167167
public ReactiveCassandraTemplate(ReactiveSessionFactory sessionFactory, CassandraConverter converter) {
168168
this(new ReactiveCqlTemplate(sessionFactory), converter);
@@ -177,7 +177,7 @@ public ReactiveCassandraTemplate(ReactiveSessionFactory sessionFactory, Cassandr
177177
* @param converter {@link CassandraConverter} used to convert between Java and Cassandra types; must not be
178178
* {@literal null}.
179179
* @see org.springframework.data.cassandra.core.convert.CassandraConverter
180-
* @see com.datastax.oss.driver.api.core.CqlSession
180+
* @see ReactiveSession
181181
*/
182182
public ReactiveCassandraTemplate(ReactiveCqlOperations reactiveCqlOperations, CassandraConverter converter) {
183183

spring-data-cassandra/src/main/java/org/springframework/data/cassandra/core/ReactiveSelectOperation.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
* <p>
3030
* The starting {@literal domainType} is used for mapping the {@link Query} provided via {@code matching} int the
3131
* Cassandra specific representation. By default, the originating {@literal domainType} is also used for mapping back
32-
* the result from the {@link com.datastax.driver.core.Row}. However, it is possible to define an different
32+
* the result from the {@link com.datastax.oss.driver.api.core.cql.Row}. However, it is possible to define an different
3333
* {@literal returnType} via {@code as} to mapping the result.
3434
* <p>
3535
* By default, the table to operate on is derived from the initial {@literal domainType} and can be defined there via

spring-data-cassandra/src/main/java/org/springframework/data/cassandra/core/convert/CassandraJodaTimeConverters.java

-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,6 @@ private CassandraJodaTimeConverters() {}
5252
* @return a {@link Collection} of Joda Time {@link Converter Converters} to register.
5353
* @see org.springframework.core.convert.converter.Converter
5454
* @see java.util.Collection
55-
* @see org.joda.time
5655
*/
5756
public static Collection<Converter<?, ?>> getConvertersToRegister() {
5857

spring-data-cassandra/src/main/java/org/springframework/data/cassandra/core/convert/CassandraThreeTenBackPortConverters.java

-1
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,6 @@ private CassandraThreeTenBackPortConverters() {}
5858
* @return a {@link Collection} of ThreeTen Backport {@link Converter Converters} to register.
5959
* @see org.springframework.core.convert.converter.Converter
6060
* @see java.util.Collection
61-
* @see org.joda.time
6261
*/
6362
public static Collection<Converter<?, ?>> getConvertersToRegister() {
6463

spring-data-cassandra/src/main/java/org/springframework/data/cassandra/core/convert/CassandraUDTValueProvider.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ public CassandraUDTValueProvider(UdtValue udtValue, CodecRegistry codecRegistry,
4444
}
4545

4646
/**
47-
* Create a new {@link CassandraUDTValueProvider} with the given {@link UDTValue} and
47+
* Create a new {@link CassandraUDTValueProvider} with the given {@link UdtValue} and
4848
* {@link DefaultSpELExpressionEvaluator}.
4949
*
5050
* @param udtValue must not be {@literal null}.

spring-data-cassandra/src/main/java/org/springframework/data/cassandra/core/convert/MappingCassandraConverter.java

+1-2
Original file line numberDiff line numberDiff line change
@@ -137,9 +137,8 @@ public MappingCassandraConverter(CassandraMappingContext mappingContext) {
137137
}
138138

139139
/**
140-
* Creates a new {@link ConversionContext} given {@link ObjectPath}.
140+
* Creates a new {@link ConversionContext}.
141141
*
142-
* @param path the current {@link ObjectPath}, must not be {@literal null}.
143142
* @return the {@link ConversionContext}.
144143
*/
145144
protected ConversionContext getConversionContext() {

spring-data-cassandra/src/main/java/org/springframework/data/cassandra/core/convert/RowValueProvider.java

-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,6 @@ public class RowValueProvider implements CassandraValueProvider {
4040
* {@link SpELExpressionEvaluator}.
4141
*
4242
* @param source must not be {@literal null}.
43-
* @param codecRegistry must not be {@literal null}.
4443
* @param evaluator must not be {@literal null}.
4544
*/
4645
public RowValueProvider(Row source, SpELExpressionEvaluator evaluator) {

spring-data-cassandra/src/main/java/org/springframework/data/cassandra/core/convert/TupleValueProvider.java

-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,6 @@ public class TupleValueProvider implements CassandraValueProvider {
4242
* Create a new {@link TupleValueProvider} with the given {@link TupleValue} and {@link SpELExpressionEvaluator}.
4343
*
4444
* @param tupleValue must not be {@literal null}.
45-
* @param codecRegistry must not be {@literal null}.
4645
* @param evaluator must not be {@literal null}.
4746
*/
4847
public TupleValueProvider(TupleValue tupleValue, SpELExpressionEvaluator evaluator) {

spring-data-cassandra/src/main/java/org/springframework/data/cassandra/core/convert/UdtValueProvider.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ public class UdtValueProvider implements CassandraValueProvider {
3535
private final SpELExpressionEvaluator evaluator;
3636

3737
/**
38-
* Create a new {@link UdtValueProvider} with the given {@link UDTValue} and {@link SpELExpressionEvaluator}.
38+
* Create a new {@link UdtValueProvider} with the given {@link UdtValue} and {@link SpELExpressionEvaluator}.
3939
*
4040
* @param udtValue must not be {@literal null}.
4141
* @param evaluator must not be {@literal null}.

spring-data-cassandra/src/main/java/org/springframework/data/cassandra/core/cql/AsyncCqlTemplate.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -838,7 +838,7 @@ protected AsyncRowCallbackHandlerResultSetExtractor(RowCallbackHandler rowCallba
838838
}
839839

840840
/* (non-Javadoc)
841-
* @see org.springframework.data.cassandra.core.cql.ResultSetExtractor#extractData(com.datastax.driver.core.ResultSet)
841+
* @see org.springframework.data.cassandra.core.cql.ResultSetExtractor#extractData(ResultSet)
842842
*/
843843
@Override
844844
@Nullable

spring-data-cassandra/src/main/java/org/springframework/data/cassandra/core/cql/AsyncRowMapperResultSetExtractor.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@
1818
import java.util.List;
1919
import java.util.stream.Collectors;
2020

21-
import com.datastax.oss.driver.api.core.DriverException;
22-
import com.datastax.oss.driver.api.core.cql.AsyncResultSet;
23-
2421
import org.springframework.dao.DataAccessException;
2522
import org.springframework.util.Assert;
2623
import org.springframework.util.concurrent.ListenableFuture;
2724

25+
import com.datastax.oss.driver.api.core.DriverException;
26+
import com.datastax.oss.driver.api.core.cql.AsyncResultSet;
27+
2828
/**
2929
* Adapter implementation of the {@link ResultSetExtractor} interface that delegates to a {@link RowMapper} which is
3030
* supposed to create an object for each row. Each object is added to the results List of this
@@ -57,7 +57,7 @@ public AsyncRowMapperResultSetExtractor(RowMapper<T> rowMapper) {
5757
}
5858

5959
/* (non-Javadoc)
60-
* @see org.springframework.data.cassandra.core.cql.ResultSetExtractor#extractData(com.datastax.driver.core.ResultSet)
60+
* @see org.springframework.data.cassandra.core.cql.ResultSetExtractor#extractData(ResultSet)
6161
*/
6262
@Override
6363
public ListenableFuture<List<T>> extractData(AsyncResultSet resultSet) throws DriverException, DataAccessException {

0 commit comments

Comments
 (0)