hazelcast/hazelcast

Describe when the HazelcastInstanceNotActiveException can occur

Open

#11,512 opened on 2017年10月4日

GitHub で見る
 (2 comments) (1 reaction) (0 assignees)Java (5,737 stars) (1,795 forks)batch import
Estimation: SPriority: MediumSource: InternalTeam: CoreType: Enhancementgood first issue

説明

It would be helpful if users are aware of possible HazelcastInstanceNotActiveException.

Suggested improvements:

  • add more detailed JavaDoc directly to HazelcastInstanceNotActiveException
  • declare this exception on most common places, where users can meet it (e.g. IQueue.take() when cluster is going down - see also hazelcast/hazelcast-code-samples#187)

This issue is also related to #11439.

The HazelcastInstanceNotActiveException doesn't extend HazelcastException, but just the java.lang.IllegalStateException.

コントリビューターガイド

技術スタック
java
領域
documentation
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
JavaHazelcast basicsJavadoc
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
80
調査方針
Add more detailed Javadoc directly to the HazelcastInstanceNotActiveException class, explaining when and why it is thrown. Additionally, declare this exception in the throws clause of commonly used methods, such as IQueue.take(), to inform users. Refer to related issue #11439 and the hazelcast code samples repository for context, and ensure that the exception does not extend HazelcastException but IllegalStateException is noted.