Skip to content

feat(core): add Connection javadoc - #135

Merged
nickkkccc merged 2 commits into
masterfrom
connection-javadoc
Oct 27, 2026
Merged

nickkkccc merged 2 commits into
masterfrom
connection-javadoc

Conversation

@nickkkccc

@nickkkccc nickkkccc commented Oct 22, 2026 •

Copy link
Copy Markdown
Contributor
  • Added Connection interface javadoc
  • Added ConnectionCloseEvent enum javadoc

I haven't forgotten about:

  • Tests
  • Changelog
  • Documentation
    • JavaDoc was written
  • Commit messages comply with the guideline
  • Cleanup the code for review. See checklist

Related issues:

@nickkkccc nickkkccc self-assigned this Oct 22, 2026
@nickkkccc
nickkkccc force-pushed the connection-javadoc branch 3 times, most recently from 8e94e3b to 2a6d124 Compare October 23, 2026 06:54
bitgorbovsky
bitgorbovsky previously approved these changes Oct 23, 2026

@dkasimovskiy dkasimovskiy left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Нужно поправить.

Comment thread tarantool-core/src/main/java/io/tarantool/core/connection/Connection.java Outdated
Comment thread tarantool-core/src/main/java/io/tarantool/core/connection/Connection.java Outdated
Comment thread tarantool-core/src/main/java/io/tarantool/core/connection/Connection.java Outdated
Comment thread tarantool-core/src/main/java/io/tarantool/core/connection/Connection.java Outdated
Comment thread tarantool-core/src/main/java/io/tarantool/core/connection/Connection.java Outdated
Comment thread tarantool-core/src/main/java/io/tarantool/core/connection/Connection.java Outdated
Comment thread tarantool-core/src/main/java/io/tarantool/core/connection/Connection.java Outdated
Comment thread tarantool-core/src/main/java/io/tarantool/core/connection/Connection.java Outdated
Comment thread tarantool-core/src/main/java/io/tarantool/core/connection/Connection.java Outdated
Comment thread tarantool-core/src/main/java/io/tarantool/core/connection/Connection.java Outdated
Comment thread tarantool-core/src/main/java/io/tarantool/core/connection/Connection.java Outdated
* the connection fails for any reason. Never null.
* @throws IllegalStateException if a connection attempt is made in a state where connecting is
* prohibited. The states in which connecting is prohibited are defined by the implementation.
* @throws IllegalArgumentException if {@code timeoutMs <= 0}.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Тут надо дополнить, что не только в случае timeoutMs <= 0, но и в случае, если неправильное состояние

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Есть же, только другой тип исключения, чуть выше - IllegalStateException

Comment thread tarantool-core/src/main/java/io/tarantool/core/connection/Connection.java Outdated
Comment thread tarantool-core/src/main/java/io/tarantool/core/connection/Connection.java Outdated
Comment thread tarantool-core/src/main/java/io/tarantool/core/connection/Connection.java Outdated
Comment thread tarantool-core/src/main/java/io/tarantool/core/connection/Connection.java Outdated
Comment thread tarantool-core/src/main/java/io/tarantool/core/connection/Connection.java Outdated
  - Fixed the notification sent to clients regarding connection
    closure. It is now guaranteed that clients are notified of the
    closure only after the connection has transitioned to the CLOSED
    state.
  - Fixed greeting object remaining non-null after connection closure.
  - Added documentation of Connection interface.
  - Added documentation of ConnectionCloseEvent enum.
@nickkkccc
nickkkccc merged commit bbcf5c0 into master Oct 27, 2026
10 of 11 checks passed
@nickkkccc
nickkkccc deleted the connection-javadoc branch October 27, 2026 11:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants