From e13ed7b8787f60021c8e9e261f97e7f4663819f8 Mon Sep 17 00:00:00 2001 From: Gian Merlino Date: Tue, 5 Mar 2024 11:52:49 -0800 Subject: [PATCH] Improve javadoc for ReadableFieldPointer. (#16043) Since #15175, the javadoc for ReadableFieldPointer is somewhat out of date. It says that the pointer only points to the beginning of the field, but this is no longer true. This patch updates the javadoc to be more accurate. --- .../apache/druid/frame/field/ReadableFieldPointer.java | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/processing/src/main/java/org/apache/druid/frame/field/ReadableFieldPointer.java b/processing/src/main/java/org/apache/druid/frame/field/ReadableFieldPointer.java index 09de051a691e..5a005a8e7adc 100644 --- a/processing/src/main/java/org/apache/druid/frame/field/ReadableFieldPointer.java +++ b/processing/src/main/java/org/apache/druid/frame/field/ReadableFieldPointer.java @@ -20,10 +20,8 @@ package org.apache.druid.frame.field; /** - * Pointer to a field position in some memory. Only points to the beginning of the field, since all fields - * can be read without knowing their entire length. - * - * See {@link org.apache.druid.frame.write.RowBasedFrameWriter} for details about the format. + * Pointer to a field position in some memory. See {@link org.apache.druid.frame.write.RowBasedFrameWriter} for details + * about the format. */ public interface ReadableFieldPointer { @@ -33,7 +31,8 @@ public interface ReadableFieldPointer long position(); /** - * Length of the field. + * Length of the field. Never necessary to read a field, since all fields can be read without knowing their + * entire length. Provided because it may be useful for reading in a more optimal manner. */ long length(); }