Skip to content

Commit 7a57cbe

Browse files
committed
BytesLocation: tweak javadoc
Add a cautionary notice that the backing ByteBuffer might change.
1 parent 4fcd959 commit 7a57cbe

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

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

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,14 @@
3535

3636
/**
3737
* {@link Location} backed by a {@link ByteBuffer}.
38-
*
38+
* <p>
39+
* Note that the backing {@link ByteBuffer} reference is mutable, and might
40+
* change to a different, larger buffer if a sufficiently large amount of data
41+
* is written to this location via a wrapping {@link BytesHandle}.
42+
* </p>
43+
*
3944
* @author Curtis Rueden
45+
* @see BytesHandle
4046
*/
4147
public class BytesLocation extends AbstractLocation {
4248

0 commit comments

Comments
 (0)