Skip to content

Commit 9526523

Browse files
committed
build: fix errors and warnings re api docs
Fixed all javadoc problems that were reported by `mvn release:clean release:prepare -DpushChanges=false`.
1 parent 9392133 commit 9526523

File tree

5 files changed

+42
-3
lines changed

5 files changed

+42
-3
lines changed

src/main/java/org/tarantool/TarantoolClientImpl.java

+17-1
Original file line numberDiff line numberDiff line change
@@ -270,6 +270,7 @@ protected Future<?> exec(Code code, Object... args) {
270270
* {@code timeoutMillis} will override the default
271271
* timeout. 0 means the limitless operation.
272272
*
273+
* @param timeoutMillis operation timeout
273274
* @param code operation code
274275
* @param args operation arguments
275276
*
@@ -736,6 +737,11 @@ public String toString() {
736737
/**
737738
* Missed in jdk8 CompletableFuture operator to limit execution
738739
* by time.
740+
*
741+
* @param timeout execution timeout
742+
* @param unit measurement unit for given timeout value
743+
*
744+
* @return a future on which the method is called
739745
*/
740746
public TarantoolOp<V> orTimeout(long timeout, TimeUnit unit) {
741747
if (timeout < 0) {
@@ -838,6 +844,8 @@ protected int getState() {
838844

839845
/**
840846
* Set CLOSED state, drop RECONNECT state.
847+
*
848+
* @return whether a state was changed to CLOSED
841849
*/
842850
protected boolean close() {
843851
for (; ; ) {
@@ -856,9 +864,13 @@ protected boolean close() {
856864
}
857865

858866
/**
859-
* Move from a current state to a give one.
867+
* Move from a current state to a given one.
860868
* <p>
861869
* Some moves are forbidden.
870+
*
871+
* @param mask union of states
872+
*
873+
* @return whether a state was changed to given one
862874
*/
863875
protected boolean acquire(int mask) {
864876
for (; ; ) {
@@ -913,6 +925,10 @@ protected boolean compareAndSet(int expect, int update) {
913925
/**
914926
* Reconnection uses another way to await state via receiving a signal
915927
* instead of latches.
928+
*
929+
* @param state desired state
930+
*
931+
* @throws InterruptedException if the current thread is interrupted
916932
*/
917933
protected void awaitState(int state) throws InterruptedException {
918934
if (state == RECONNECT) {

src/main/java/org/tarantool/jdbc/SQLStatement.java

+16-2
Original file line numberDiff line numberDiff line change
@@ -404,6 +404,9 @@ public boolean isWrapperFor(Class<?> type) throws SQLException {
404404

405405
/**
406406
* Clears the results of the most recent execution.
407+
*
408+
* @throws SQLException if this method is called on a closed
409+
* {@code Statement}
407410
*/
408411
protected void discardLastResults() throws SQLException {
409412
final SQLResultSet lastResultSet = resultSet;
@@ -425,10 +428,18 @@ protected void discardLastResults() throws SQLException {
425428
/**
426429
* Performs query execution.
427430
*
428-
* @param sql query
429-
* @param params optional params
431+
* @param autoGeneratedKeys whether auto-generated keys should be collected;
432+
* one of the following constants:
433+
* {@code Statement.RETURN_GENERATED_KEYS},
434+
* {@code Statement.NO_GENERATED_KEYS}
435+
* @see #getGeneratedKeys()
436+
* @param sql query
437+
* @param params optional params
430438
*
431439
* @return {@code true}, if the result is a ResultSet object;
440+
*
441+
* @throws SQLException if this method is called on a closed
442+
* {@code Statement}
432443
*/
433444
protected boolean executeInternal(int autoGeneratedKeys, String sql, Object... params) throws SQLException {
434445
discardLastResults();
@@ -456,6 +467,9 @@ protected boolean executeInternal(int autoGeneratedKeys, String sql, Object... p
456467
* @param queries batch queries
457468
*
458469
* @return update count result per query
470+
*
471+
* @throws SQLException if this method is called on a closed
472+
* {@code Statement}
459473
*/
460474
protected int[] executeBatchInternal(List<SQLQueryHolder> queries) throws SQLException {
461475
SQLBatchResultHolder batchResult = connection.executeBatch(timeout, queries);

src/main/java/org/tarantool/jdbc/TarantoolStatement.java

+3
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ public interface TarantoolStatement extends Statement {
1212
/**
1313
* Checks for statement completion and closes itself,
1414
* according to {@link Statement#closeOnCompletion()}.
15+
*
16+
* @throws SQLException if this method is called on a closed
17+
* {@code Statement}
1518
*/
1619
void checkCompletion() throws SQLException;
1720

src/main/java/org/tarantool/logging/LoggerFactory.java

+2
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
* } </pre>
1818
* <p>
1919
* There are four major attempts to load the logger provider:
20+
* <ol>
2021
* <li>
2122
* Use a runtime system property {@literal org.tarantool.logging.provider}.
2223
* Possible values are 'slf4j' or 'jdk'. (for instance,
@@ -32,6 +33,7 @@
3233
* <li>
3334
* Use JUL implementation if none of above attempts are successful.
3435
* </li>
36+
* </ol>
3537
* <p>
3638
* This class is not a part of public API.
3739
*/

src/main/java/org/tarantool/protocol/ProtoUtils.java

+4
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ public abstract class ProtoUtils {
3838
* Reads tarantool binary protocol's packet from {@code inputStream}.
3939
*
4040
* @param inputStream ready to use input stream
41+
* @param msgPackLite MessagePack decoder instance
4142
*
4243
* @return Nonnull instance of packet
4344
*
@@ -64,6 +65,7 @@ public static TarantoolPacket readPacket(InputStream inputStream, MsgPackLite ms
6465
*
6566
* @param bufferReader readable channel that have to be in blocking mode
6667
* or instance of {@link ReadableViaSelectorChannel}
68+
* @param msgPackLite MessagePack decoder instance
6769
*
6870
* @return tarantool binary protocol message wrapped by instance of {@link TarantoolPacket}
6971
*
@@ -121,6 +123,7 @@ public static TarantoolPacket readPacket(ReadableByteChannel bufferReader, MsgPa
121123
* @param socket a socket channel to a tarantool node
122124
* @param username auth username
123125
* @param password auth password
126+
* @param msgPackLite MessagePack encoder / decoder instance
124127
*
125128
* @return object with information about a connection/
126129
*
@@ -163,6 +166,7 @@ public static TarantoolGreeting connect(Socket socket,
163166
* @param channel a socket channel to tarantool node. The channel have to be in blocking mode
164167
* @param username auth username
165168
* @param password auth password
169+
* @param msgPackLite MessagePack encoder / decoder instance
166170
*
167171
* @return object with information about a connection/
168172
*

0 commit comments

Comments
 (0)