[ARROW-17570] [Java][Doc] Add JavaDoc to TransferPair interface

• Type: Improvement
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Component/s: Documentation, Java
• External issue URL: https://github.com/apache/arrow/issues/32820
• Assignee: Unassigned
• Reporter: Larry White
• Created: 30/Aug/22 15:51
• Updated: 11/Jan/23 11:51

Description

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.