Skip to content

Commit 705a1ab

Browse files
MakarovSdmitry-timofeev
authored andcommitted
Improve Javadocs (#1002)
In Node '@throws IllegalStateException if the node proxy is closed' specification is not applicable to NodeFake.
1 parent 56f6af3 commit 705a1ab

File tree

3 files changed

+6
-8
lines changed

3 files changed

+6
-8
lines changed

exonum-java-binding/core/src/main/java/com/exonum/binding/core/service/Node.java

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ public interface Node {
5353
HashCode submitTransaction(RawTransaction rawTransaction);
5454

5555
/**
56-
* Performs a given function with a snapshot of the current database state.
56+
* Performs the given function with a snapshot of the current database state.
5757
*
5858
* @param snapshotFunction a function to execute
5959
* @param <ResultT> a type the function returns
@@ -66,8 +66,6 @@ public interface Node {
6666
* for signing transactions in {@link #submitTransaction(RawTransaction)}.
6767
*
6868
* <p>This key is stored under "service_public_key" key in the node configuration file.
69-
*
70-
* @throws IllegalStateException if the node proxy is closed
7169
*/
7270
PublicKey getPublicKey();
7371
}

exonum-java-binding/testkit/src/main/java/com/exonum/binding/testkit/TestKit.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -291,7 +291,7 @@ private static <T> Stream<T> stream(KeySetIndexProxy<T> setIndex) {
291291
}
292292

293293
/**
294-
* Performs a given function with a snapshot of the current database state (i.e., the one that
294+
* Performs the given function with a snapshot of the current database state (i.e., the one that
295295
* corresponds to the latest committed block). In-pool (not yet processed) transactions are also
296296
* accessible with it in {@linkplain Blockchain#getTxMessages() blockchain}.
297297
*
@@ -309,7 +309,7 @@ public void withSnapshot(Consumer<Snapshot> snapshotFunction) {
309309
}
310310

311311
/**
312-
* Performs a given function with a snapshot of the current database state (i.e., the one that
312+
* Performs the given function with a snapshot of the current database state (i.e., the one that
313313
* corresponds to the latest committed block) and returns a result of its execution. In-pool
314314
* (not yet processed) transactions are also accessible with it in
315315
* {@linkplain Blockchain#getTxMessages() blockchain}.

exonum-java-binding/testkit/src/main/java/com/exonum/binding/testkit/TestKitExtension.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
* .withService(TestServiceModule.class));
4141
*
4242
* &#64;BeforeEach
43-
* void setUp() {
43+
* void setUp(TestKit testKit) {
4444
* // Set up
4545
* }
4646
*
@@ -73,8 +73,8 @@
7373
* <p>As different tests might need slightly different TestKit configuration, following
7474
* parameterization annotations are available:
7575
* <ul>
76-
* <li>{@link Validator} sets main TestKit validator node type to validator</li>
77-
* <li>{@link Auditor} sets main TestKit validator node type to auditor</li>
76+
* <li>{@link Validator} sets main TestKit node type to validator</li>
77+
* <li>{@link Auditor} sets main TestKit node type to auditor</li>
7878
* <li>{@link ValidatorCount} sets number of validator nodes in the TestKit network</li>
7979
* </ul>
8080
* These annotations should be applied on TestKit parameter:

0 commit comments

Comments
 (0)