Skip to content

Commit

Permalink
Add note about expectNextRecord to javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
JakobEdding committed Apr 12, 2024
1 parent 373e319 commit 68dad1f
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,10 @@ public <VR> TestOutput<K, VR> withValueSerde(final Serde<VR> valueSerde) {
}

/**
* Reads the next record as creates an {@link Expectation} for it.<br/>
* Reads the next record and creates an {@link Expectation} for it.<br/>
*
* Note that calling `.expectNextRecord()` by itself without chaining at least one of the `.has*` methods will not
* check for the existence of a next record!<br/>
*
* @return An {@link Expectation} containing the next record from the output.<br/>
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ public Expectation<K, V> and() {
}

/**
* <p>Reads the next record as creates an {@code Expectation} for it.</p>
* <p>Reads the next record and creates an {@code Expectation} for it.</p>
* <p>This is logically equivalent to {@link TestOutput#expectNextRecord()}.</p>
* <p>This methods main purpose is to allow chaining:</p>
* <pre>{@code
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ default <VR> TestOutput<K, VR> withValueType(final Class<VR> valueType) {
ProducerRecord<K, V> readOneRecord();

/**
* Reads the next record as creates an {@link Expectation} for it.
* Reads the next record and creates an {@link Expectation} for it.
*
* @return An {@link Expectation} containing the next record from the output.
*/
Expand Down

0 comments on commit 68dad1f

Please sign in to comment.