Fix javadoc to add @param annotation for BufferAllocator

apache · lidavidm · Jun 18, 2023 · Mar 3, 2023 · Mar 3, 2023 · Jun 4, 2023
commit ca118870cf4edb94344ec00f5908469565c32818
@@ -582,7 +582,8 @@ public TransferPair getTransferPair(BufferAllocator allocator) {
 
   /**
    * Construct a transfer pair of this vector and another vector of same type.
-   * @param field Field object used by the vector
+   * @param field Field object used by the target vector
+   * @param allocator allocator for the target vector
    * @return TransferPair
    */
   public abstract TransferPair getTransferPair(Field field, BufferAllocator allocator);

@@ -308,7 +308,8 @@ public TransferPair getTransferPair(String ref, BufferAllocator allocator) {
    * Construct a TransferPair comprising of this and a target vector of
    * the same type.
    *
-   * @param field Field object used by the vector
+   * @param field Field object used by the target vector
+   * @param allocator allocator for the target vector
    * @return {@link TransferPair}
    */
   @Override

@@ -564,7 +564,8 @@ public TransferPair getTransferPair(String ref, BufferAllocator allocator) {
    * Construct a TransferPair comprising of this and a target vector of
    * the same type.
    *
-   * @param field Field object used by the vector
+   * @param field Field object used by the target vector
+   * @param allocator allocator for the target vector
    * @return {@link TransferPair}
    */
   @Override

@@ -312,7 +312,8 @@ public TransferPair getTransferPair(String ref, BufferAllocator allocator) {
    * Construct a TransferPair comprising of this and a target vector of
    * the same type.
    *
-   * @param field Field object used by the vector
+   * @param field Field object used by the target vector
+   * @param allocator allocator for the target vector
    * @return {@link TransferPair}
    */
   @Override

@@ -314,7 +314,8 @@ public TransferPair getTransferPair(String ref, BufferAllocator allocator) {
    * Construct a TransferPair comprising of this and a target vector of
    * the same type.
    *
-   * @param field Field object used by the vector
+   * @param field Field object used by the target vector
+   * @param allocator allocator for the target vector
    * @return {@link TransferPair}
    */
   @Override

@@ -553,7 +553,8 @@ public TransferPair getTransferPair(String ref, BufferAllocator allocator) {
    * Construct a TransferPair comprising of this and a target vector of
    * the same type.
    *
-   * @param field Field object used by the vector
+   * @param field Field object used by the target vector
+   * @param allocator allocator for the target vector
    * @return {@link TransferPair}
    */
   @Override

@@ -552,7 +552,8 @@ public TransferPair getTransferPair(String ref, BufferAllocator allocator) {
    * Construct a TransferPair comprising of this and a target vector of
    * the same type.
    *
-   * @param field Field object used by the vector
+   * @param field Field object used by the target vector
+   * @param allocator allocator for the target vector
    * @return {@link TransferPair}
    */
   @Override

@@ -370,7 +370,8 @@ public TransferPair getTransferPair(String ref, BufferAllocator allocator) {
    * Construct a TransferPair comprising of this and a target vector of
    * the same type.
    *
-   * @param field Field object used by the vector
+   * @param field Field object used by the target vector
+   * @param allocator allocator for the target vector
    * @return {@link TransferPair}
    */
   @Override

@@ -351,7 +351,8 @@ public TransferPair getTransferPair(String ref, BufferAllocator allocator) {
    * Construct a TransferPair comprising of this and a target vector of
    * the same type.
    *
-   * @param field Field object used by the vector
+   * @param field Field object used by the target vector
+   * @param allocator allocator for the target vector
    * @return {@link TransferPair}
    */
   @Override

@@ -326,7 +326,8 @@ public TransferPair getTransferPair(String ref, BufferAllocator allocator) {
    * Construct a TransferPair comprising of this and a target vector of
    * the same type.
    *
-   * @param field Field object used by the vector
+   * @param field Field object used by the target vector
+   * @param allocator allocator for the target vector
    * @return {@link TransferPair}
    */
   @Override

@@ -327,7 +327,8 @@ public TransferPair getTransferPair(String ref, BufferAllocator allocator) {
    * Construct a TransferPair comprising of this and a target vector of
    * the same type.
    *
-   * @param field Field object used by the vector
+   * @param field Field object used by the target vector
+   * @param allocator allocator for the target vector
    * @return {@link TransferPair}
    */
   @Override

@@ -312,7 +312,8 @@ public TransferPair getTransferPair(String ref, BufferAllocator allocator) {
    * Construct a TransferPair comprising of this and a target vector of
    * the same type.
    *
-   * @param field Field object used by the vector
+   * @param field Field object used by the target vector
+   * @param allocator allocator for the target vector
    * @return {@link TransferPair}
    */
   @Override

@@ -397,7 +397,8 @@ public TransferPair getTransferPair(String ref, BufferAllocator allocator) {
    * Construct a TransferPair comprising of this and a target vector of
    * the same type.
    *
-   * @param field Field object used by the vector
+   * @param field Field object used by the target vector
+   * @param allocator allocator for the target vector
    * @return {@link TransferPair}
    */
   @Override

@@ -406,7 +406,8 @@ public TransferPair getTransferPair(String ref, BufferAllocator allocator) {
    * Construct a TransferPair comprising of this and a target vector of
    * the same type.
    *
-   * @param field Field object used by the vector
+   * @param field Field object used by the target vector
+   * @param allocator allocator for the target vector
    * @return {@link TransferPair}
    */
   @Override

@@ -346,7 +346,8 @@ public TransferPair getTransferPair(String ref, BufferAllocator allocator) {
    * Construct a TransferPair comprising of this and a target vector of
    * the same type.
    *
-   * @param field Field object used by the vector
+   * @param field Field object used by the target vector
+   * @param allocator allocator for the target vector
    * @return {@link TransferPair}
    */
   @Override

@@ -339,7 +339,8 @@ public TransferPair getTransferPair(String ref, BufferAllocator allocator) {
    * Construct a TransferPair comprising of this and a target vector of
    * the same type.
    *
-   * @param field Field object used by the vector
+   * @param field Field object used by the target vector
+   * @param allocator allocator for the target vector
    * @return {@link TransferPair}
    */
   @Override

@@ -312,7 +312,8 @@ public TransferPair getTransferPair(String ref, BufferAllocator allocator) {
    * Construct a TransferPair comprising of this and a target vector of
    * the same type.
    *
-   * @param field Field object used by the vector
+   * @param field Field object used by the target vector
+   * @param allocator allocator for the target vector
    * @return {@link TransferPair}
    */
   @Override

@@ -315,7 +315,8 @@ public TransferPair getTransferPair(String ref, BufferAllocator allocator) {
    * Construct a TransferPair comprising of this and a target vector of
    * the same type.
    *
-   * @param field Field object used by the vector
+   * @param field Field object used by the target vector
+   * @param allocator allocator for the target vector
    * @return {@link TransferPair}
    */
   @Override

@@ -312,7 +312,8 @@ public TransferPair getTransferPair(String ref, BufferAllocator allocator) {
    * Construct a TransferPair comprising of this and a target vector of
    * the same type.
    *
-   * @param field Field object used by the vector
+   * @param field Field object used by the target vector
+   * @param allocator allocator for the target vector
    * @return {@link TransferPair}
    */
   @Override

@@ -313,7 +313,8 @@ public TransferPair getTransferPair(String ref, BufferAllocator allocator) {
    * Construct a TransferPair comprising of this and a target vector of
    * the same type.
    *
-   * @param field Field object used by the vector
+   * @param field Field object used by the target vector
+   * @param allocator allocator for the target vector
    * @return {@link TransferPair}
    */
   @Override

@@ -249,7 +249,8 @@ public TransferPair getTransferPair(String ref, BufferAllocator allocator) {
    * Construct a TransferPair comprising of this and a target vector of
    * the same type.
    *
-   * @param field Field object used by the vector
+   * @param field Field object used by the target vector
+   * @param allocator allocator for the target vector
    * @return {@link TransferPair}
    */
   @Override

@@ -236,7 +236,8 @@ public TransferPair getTransferPair(String ref, BufferAllocator allocator) {
    * Construct a TransferPair comprising of this and a target vector of
    * the same type.
    *
-   * @param field Field object used by the vector
+   * @param field Field object used by the target vector
+   * @param allocator allocator for the target vector
    * @return {@link TransferPair}
    */
   @Override

@@ -248,7 +248,8 @@ public TransferPair getTransferPair(String ref, BufferAllocator allocator) {
    * Construct a TransferPair comprising of this and a target vector of
    * the same type.
    *
-   * @param field Field object used by the vector
+   * @param field Field object used by the target vector
+   * @param allocator allocator for the target vector
    * @return {@link TransferPair}
    */
   @Override

@@ -236,7 +236,8 @@ public TransferPair getTransferPair(String ref, BufferAllocator allocator) {
    * Construct a TransferPair comprising of this and a target vector of
    * the same type.
    *
-   * @param field Field object used by the vector
+   * @param field Field object used by the target vector
+   * @param allocator allocator for the target vector
    * @return {@link TransferPair}
    */
   @Override

@@ -251,7 +251,8 @@ public TransferPair getTransferPair(String ref, BufferAllocator allocator) {
    * Construct a TransferPair comprising of this and a target vector of
    * the same type.
    *
-   * @param field Field object used by the vector
+   * @param field Field object used by the target vector
+   * @param allocator allocator for the target vector
    * @return {@link TransferPair}
    */
   @Override

@@ -236,7 +236,8 @@ public TransferPair getTransferPair(String ref, BufferAllocator allocator) {
    * Construct a TransferPair comprising of this and a target vector of
    * the same type.
    *
-   * @param field Field object used by the vector
+   * @param field Field object used by the target vector
+   * @param allocator allocator for the target vector
    * @return {@link TransferPair}
    */
   @Override

@@ -248,7 +248,8 @@ public TransferPair getTransferPair(String ref, BufferAllocator allocator) {
    * Construct a TransferPair comprising of this and a target vector of
    * the same type.
    *
-   * @param field Field object used by the vector
+   * @param field Field object used by the target vector
+   * @param allocator allocator for the target vector
    * @return {@link TransferPair}
    */
   @Override

@@ -237,7 +237,8 @@ public TransferPair getTransferPair(String ref, BufferAllocator allocator) {
    * Construct a TransferPair comprising of this and a target vector of
    * the same type.
    *
-   * @param field Field object used by the vector
+   * @param field Field object used by the target vector
+   * @param allocator allocator for the target vector
    * @return {@link TransferPair}
    */
   @Override

@@ -340,7 +340,8 @@ public TransferPair getTransferPair(String ref, BufferAllocator allocator) {
    * Construct a TransferPair comprising of this and a target vector of
    * the same type.
    *
-   * @param field Field object used by the vector
+   * @param field Field object used by the target vector
+   * @param allocator allocator for the target vector
    * @return {@link TransferPair}
    */
   @Override

@@ -324,7 +324,8 @@ public TransferPair getTransferPair(String ref, BufferAllocator allocator) {
    * Construct a TransferPair comprising of this and a target vector of
    * the same type.
    *
-   * @param field Field object used by the vector
+   * @param field Field object used by the target vector
+   * @param allocator allocator for the target vector
    * @return {@link TransferPair}
    */
   @Override

@@ -301,7 +301,8 @@ public TransferPair getTransferPair(String ref, BufferAllocator allocator) {
    * Construct a TransferPair comprising of this and a target vector of
    * the same type.
    *
-   * @param field Field object used by the vector
+   * @param field Field object used by the target vector
+   * @param allocator allocator for the target vector
    * @return {@link TransferPair}
    */
   @Override

@@ -296,7 +296,8 @@ public TransferPair getTransferPair(String ref, BufferAllocator allocator) {
    * Construct a TransferPair comprising of this and a target vector of
    * the same type.
    *
-   * @param field Field object used by the vector
+   * @param field Field object used by the target vector
+   * @param allocator allocator for the target vector
    * @return {@link TransferPair}
    */
   @Override

@@ -291,7 +291,8 @@ public TransferPair getTransferPair(String ref, BufferAllocator allocator) {
    * Construct a TransferPair comprising of this and a target vector of
    * the same type.
    *
-   * @param field Field object used by the vector
+   * @param field Field object used by the target vector
+   * @param allocator allocator for the target vector
    * @return {@link TransferPair}
    */
   @Override