Skip to content

Improve javadoc for ReadableFieldPointer. #16043

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gianm merged 1 commit into from
Mar 5, 2024
Merged

Improve javadoc for ReadableFieldPointer. #16043

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions processing/src/main/java/org/apache/druid/frame/field/ReadableFieldPointer.java
View file
Open in desktop
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();
}