Skip to content

Commit fd5bf70

Browse files
committed
DataHandle: update some javadoc
We avoid the term "pointer" (especially "file pointer"). DataHandle plugins are more general than just files.
1 parent 64aa687 commit fd5bf70

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

src/main/java/org/scijava/io/handle/DataHandle.java

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -126,8 +126,8 @@ default int read(final ByteBuffer buf, final int len) throws IOException {
126126
}
127127

128128
/**
129-
* Sets the stream pointer offset, measured from the beginning of the stream,
130-
* at which the next read or write occurs.
129+
* Sets the stream offset, measured from the beginning of the stream, at which
130+
* the next read or write occurs.
131131
*/
132132
void seek(long pos) throws IOException;
133133

@@ -203,9 +203,8 @@ default String findString(final String... terminators) throws IOException {
203203
* Reads or skips a string ending with one of the given terminating
204204
* substrings.
205205
*
206-
* @param saveString Whether to collect the string from the current file
207-
* pointer to the terminating bytes, and return it. If false, returns
208-
* null.
206+
* @param saveString Whether to collect the string from the current offset to
207+
* the terminating bytes, and return it. If false, returns null.
209208
* @param terminators The strings for which to search.
210209
* @throws IOException If saveString flag is set and the maximum search length
211210
* (512 MB) is exceeded.
@@ -239,9 +238,8 @@ default String findString(final int blockSize, final String... terminators)
239238
* Reads or skips a string ending with one of the given terminating
240239
* substrings, using the specified block size for buffering.
241240
*
242-
* @param saveString Whether to collect the string from the current file
243-
* pointer to the terminating bytes, and return it. If false, returns
244-
* null.
241+
* @param saveString Whether to collect the string from the current offset
242+
* to the terminating bytes, and return it. If false, returns null.
245243
* @param blockSize The block size to use when reading bytes in chunks.
246244
* @param terminators The strings for which to search.
247245
* @throws IOException If saveString flag is set and the maximum search length

0 commit comments

Comments
 (0)