Skip to content

Commit

Permalink
Improve javadoc for ReadableFieldPointer.
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
gianm committed Mar 5, 2024
1 parent e469b7e commit 21fc216
Showing 1 changed file with 4 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand All @@ -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();
}

0 comments on commit 21fc216

Please sign in to comment.