Skip to content

Commit

Permalink
Javadoc suggestions
Browse files Browse the repository at this point in the history
  • Loading branch information
niloc132 committed Jun 4, 2024
1 parent 6a23dcf commit a321d83
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@
*/
public interface BarrageStreamGenerator extends SafeCloseable {

/**
* Represents a single update, which might be sent as multiple distinct payloads as necessary based in the
* implementation.
*/
interface MessageView {
void forEachStream(Consumer<DefensiveDrainable> visitor) throws IOException;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -647,8 +647,9 @@ int visit(final RecordBatchMessageView view, final long startRange, final int ta
}

/**
* Returns an InputStream of the message filtered to the viewport. This function accepts `targetBatchSize` but may
* actually write fewer rows than the target (when crossing an internal chunk boundary, e.g.)
* Returns an InputStream of a single FlightData message filtered to the viewport (if provided). This function
* accepts {@code targetBatchSize}, but may actually write fewer rows than the target (e.g. when crossing an
* internal chunk boundary).
*
* @param view the view of the overall chunk to generate a RecordBatch for
* @param offset the start of the batch in position space w.r.t. the view (inclusive)
Expand Down

0 comments on commit a321d83

Please sign in to comment.