Skip to content

Commit e12e8b9

Browse files
ctruedengab1one
authored andcommitted
DataHandle: update some javadoc
We avoid the term "pointer" (especially "file pointer"). DataHandle plugins are more general than just files.
1 parent 927620d commit e12e8b9

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

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

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

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

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

0 commit comments

Comments
 (0)