search

apache / arrow-java

Official Java implementation of Apache Arrow
https://arrow.apache.org/
Apache License 2.0
4 stars 4 forks source link

[Java][Doc] Add JavaDoc to TransferPair interface #247

Open asfimport opened 2 years ago

asfimport commented 2 years ago

The TransferPair interface is important to the Java vector module's memory management, but there is only a single line class comment, and no comments for the methods. The implementations of those methods have subtitles that are hidden in the method names. For example, the method transferTo() clears the memory in the original vector and resets the rowCount to 0, but splitAndTransferTo() only copies the values into new memory and the original is unchanged.  

Reporter: Larry White / @lwhite1

Note: This issue was originally created as ARROW-17570. Please see the migration documentation for further details.

asfimport commented 1 year ago

Apache Arrow JIRA Bot: This issue was last updated over 90 days ago, which may be an indication it is no longer being actively worked. To better reflect the current state, the issue is being unassigned per project policy. Please feel free to re-take assignment of the issue if it is being actively worked, or if you plan to start that work soon.