From 2b1313e989091acac78455005ba1e5fe95e619a6 Mon Sep 17 00:00:00 2001 From: proflin Date: Sat, 20 Feb 2016 22:25:38 +0800 Subject: [PATCH 1/2] Fix mismatch of javadoc names and method parameters --- .../main/java/org/apache/arrow/memory/AllocationManager.java | 2 -- .../org/apache/arrow/memory/AllocatorClosedException.java | 5 +++-- .../main/java/org/apache/arrow/memory/ChildAllocator.java | 5 +---- .../java/org/apache/arrow/memory/util/HistoricalLog.java | 2 +- .../main/java/org/apache/arrow/vector/AllocationHelper.java | 2 +- .../org/apache/arrow/vector/complex/ContainerVectorLike.java | 2 +- 6 files changed, 7 insertions(+), 11 deletions(-) diff --git a/java/memory/src/main/java/org/apache/arrow/memory/AllocationManager.java b/java/memory/src/main/java/org/apache/arrow/memory/AllocationManager.java index 0db61443266c6..d525e1df220ad 100644 --- a/java/memory/src/main/java/org/apache/arrow/memory/AllocationManager.java +++ b/java/memory/src/main/java/org/apache/arrow/memory/AllocationManager.java @@ -356,8 +356,6 @@ public ArrowBuf newDrillBuf(int offset, int length) { * The length in bytes that this DrillBuf will provide access to. * @param manager * An optional BufferManager argument that can be used to manage expansion of this DrillBuf - * @param retain - * Whether or not the newly created buffer should get an additional reference count added to it. * @return A new DrillBuf that shares references with all DrillBufs associated with this BufferLedger */ public ArrowBuf newDrillBuf(int offset, int length, BufferManager manager) { diff --git a/java/memory/src/main/java/org/apache/arrow/memory/AllocatorClosedException.java b/java/memory/src/main/java/org/apache/arrow/memory/AllocatorClosedException.java index 566457981c7ed..3274642dedd59 100644 --- a/java/memory/src/main/java/org/apache/arrow/memory/AllocatorClosedException.java +++ b/java/memory/src/main/java/org/apache/arrow/memory/AllocatorClosedException.java @@ -20,11 +20,12 @@ /** * Exception thrown when a closed BufferAllocator is used. Note * this is an unchecked exception. - * - * @param message string associated with the cause */ @SuppressWarnings("serial") public class AllocatorClosedException extends RuntimeException { + /** + * @param message string associated with the cause + */ public AllocatorClosedException(String message) { super(message); } diff --git a/java/memory/src/main/java/org/apache/arrow/memory/ChildAllocator.java b/java/memory/src/main/java/org/apache/arrow/memory/ChildAllocator.java index 6f120e5328bd4..11c9063fc9c69 100644 --- a/java/memory/src/main/java/org/apache/arrow/memory/ChildAllocator.java +++ b/java/memory/src/main/java/org/apache/arrow/memory/ChildAllocator.java @@ -31,15 +31,12 @@ class ChildAllocator extends BaseAllocator { * Constructor. * * @param parentAllocator parent allocator -- the one creating this child - * @param allocatorOwner a handle to the object making the request - * @param allocationPolicy the allocation policy to use; the policy for all - * allocators must match for each invocation of a drillbit + * @param name the name of this child allocator * @param initReservation initial amount of space to reserve (obtained from the parent) * @param maxAllocation maximum amount of space that can be obtained from this allocator; * note this includes direct allocations (via {@see BufferAllocator#buffer(int, int)} * et al) and requests from descendant allocators. Depending on the allocation policy in * force, even less memory may be available - * @param flags one or more of BaseAllocator.F_* flags */ ChildAllocator( BaseAllocator parentAllocator, diff --git a/java/memory/src/main/java/org/apache/arrow/memory/util/HistoricalLog.java b/java/memory/src/main/java/org/apache/arrow/memory/util/HistoricalLog.java index 38cb779343ab6..c9b5c5385c596 100644 --- a/java/memory/src/main/java/org/apache/arrow/memory/util/HistoricalLog.java +++ b/java/memory/src/main/java/org/apache/arrow/memory/util/HistoricalLog.java @@ -126,7 +126,7 @@ public void buildHistory(final StringBuilder sb, boolean includeStackTrace) { /** * * @param sb - * @param indexLevel + * @param indent * @param includeStackTrace */ public synchronized void buildHistory(final StringBuilder sb, int indent, boolean includeStackTrace) { diff --git a/java/vector/src/main/java/org/apache/arrow/vector/AllocationHelper.java b/java/vector/src/main/java/org/apache/arrow/vector/AllocationHelper.java index 54c3cd7331e0f..15c3a0227c656 100644 --- a/java/vector/src/main/java/org/apache/arrow/vector/AllocationHelper.java +++ b/java/vector/src/main/java/org/apache/arrow/vector/AllocationHelper.java @@ -49,7 +49,7 @@ public static void allocate(ValueVector v, int valueCount, int bytesPerValue, in * Allocates the exact amount if v is fixed width, otherwise falls back to dynamic allocation * @param v value vector we are trying to allocate * @param valueCount size we are trying to allocate - * @throws org.apache.drill.exec.memory.OutOfMemoryException if it can't allocate the memory + * @throws org.apache.arrow.memory.OutOfMemoryException if it can't allocate the memory */ public static void allocateNew(ValueVector v, int valueCount) { if (v instanceof FixedWidthVector) { diff --git a/java/vector/src/main/java/org/apache/arrow/vector/complex/ContainerVectorLike.java b/java/vector/src/main/java/org/apache/arrow/vector/complex/ContainerVectorLike.java index e50b0d0d0a5ea..655b55a6aa2c6 100644 --- a/java/vector/src/main/java/org/apache/arrow/vector/complex/ContainerVectorLike.java +++ b/java/vector/src/main/java/org/apache/arrow/vector/complex/ContainerVectorLike.java @@ -31,7 +31,7 @@ public interface ContainerVectorLike { * * @param descriptor vector descriptor * @return result of operation wrapping vector corresponding to the given descriptor and whether it's newly created - * @throws org.apache.drill.common.exceptions.DrillRuntimeException + * @throws org.apache.arrow.vector.util.SchemaChangeRuntimeException * if schema change is not permissible between the given and existing data vector types. */ AddOrGetResult addOrGetVector(VectorDescriptor descriptor); From 99366ab829a869c58ac5961777ee7941f2eb7dec Mon Sep 17 00:00:00 2001 From: Liwei Lin Date: Mon, 22 Feb 2016 16:42:27 +0800 Subject: [PATCH 2/2] ARROW-10: Fix mismatch of javadoc names and method parameters --- .../main/java/org/apache/arrow/memory/AllocationManager.java | 3 ++- .../src/main/java/org/apache/arrow/memory/BufferManager.java | 1 + 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/java/memory/src/main/java/org/apache/arrow/memory/AllocationManager.java b/java/memory/src/main/java/org/apache/arrow/memory/AllocationManager.java index bfe1363645733..43ee9c108d902 100644 --- a/java/memory/src/main/java/org/apache/arrow/memory/AllocationManager.java +++ b/java/memory/src/main/java/org/apache/arrow/memory/AllocationManager.java @@ -328,7 +328,8 @@ public int decrement(int decrement) { * destroyed before use. * * @param allocator - * @return + * A BufferAllocator. + * @return The ledger associated with the BufferAllocator. */ public BufferLedger getLedgerForAllocator(BufferAllocator allocator) { return associate((BaseAllocator) allocator); diff --git a/java/memory/src/main/java/org/apache/arrow/memory/BufferManager.java b/java/memory/src/main/java/org/apache/arrow/memory/BufferManager.java index d6470fa51e7a2..8969434791012 100644 --- a/java/memory/src/main/java/org/apache/arrow/memory/BufferManager.java +++ b/java/memory/src/main/java/org/apache/arrow/memory/BufferManager.java @@ -43,6 +43,7 @@ public interface BufferManager extends AutoCloseable { * @param newSize * Size of new replacement buffer. * @return + * A new version of the buffer. */ public ArrowBuf replace(ArrowBuf old, int newSize);