blob: 3c695c68445fa5b5513bb55087a305164f33b6ee (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
|
package bjc.utils.ioutils.blocks;
import java.io.IOException;
import java.util.Iterator;
import java.util.function.Consumer;
/**
* A source of blocks of characters, marked with line numbers as to block
* start/block end.
*
* @author bjculkin
*
*/
public interface BlockReader extends AutoCloseable, Iterator<Block> {
/**
* Check if this reader has an available block.
*
* @return Whether or not another block is available.
*/
boolean hasNextBlock();
/**
* Get the current block.
*
* @return The current block, or null if there is no current block.
*/
Block getBlock();
/**
* Move to the next block.
*
* @return Whether or not the next block was successfully read.
*/
boolean nextBlock();
/**
* Retrieve the number of blocks that have been read so far.
*
* @return The number of blocks read so far.
*/
int getBlockCount();
@Override
void close() throws IOException;
/*
* Methods with default impls.
*/
/**
* Execute an action for each remaining block.
*
* @param action
* The action to execute for each block
*/
default void forEachBlock(final Consumer<Block> action) {
while (hasNext()) {
action.accept(next());
}
}
@Override
default boolean hasNext() {
return hasNextBlock();
}
@Override
default Block next() {
nextBlock();
return getBlock();
}
}
|
