Add JavaDoc for byte-ish blocks

prestodb · Apr 1, 2024 · ca5749d · ca5749d
1 parent 32e4ab3
commit ca5749d
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/presto-common/src/main/java/com/facebook/presto/common/block/ByteArrayBlock.java b/presto-common/src/main/java/com/facebook/presto/common/block/ByteArrayBlock.java
@@ -35,6 +35,13 @@
 import static io.airlift.slice.SizeOf.sizeOf;
 import static java.lang.String.format;
 
+/**
+ * A block that contains positionCount bytes. Only bytes can be read.
+ * Other block methods like getInt(), getLong(), etc. throw UnsupportedOperationException.
+ *
+ * Despite the name, this block contains individual bytes, not byte arrays.
+ * For byte arrays use a VariableWidthBlock.
+ */
 public class ByteArrayBlock
         implements Block
 {

diff --git a/presto-common/src/main/java/com/facebook/presto/common/block/VariableWidthBlock.java b/presto-common/src/main/java/com/facebook/presto/common/block/VariableWidthBlock.java
@@ -40,6 +40,12 @@
 import static io.airlift.slice.Slices.EMPTY_SLICE;
 import static java.lang.String.format;
 
+/**
+ * A block that contains positionCount elements.
+ * All block methods are supported: getInt(), getLong(), etc.
+ * Whether the values they return make sense depends on what
+ * was stored at that position.
+ */
 public class VariableWidthBlock
         extends AbstractVariableWidthBlock
 {