Skip to content

Commit 9186cb3

Browse files
committed
ARROW-10: Fix mismatch of javadoc names and method parameters
2 parents e6905ef + 2b1313e commit 9186cb3

File tree

6 files changed

+7
-11
lines changed

6 files changed

+7
-11
lines changed

java/memory/src/main/java/org/apache/arrow/memory/AllocationManager.java

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -356,8 +356,6 @@ public ArrowBuf newArrowBuf(int offset, int length) {
356356
* The length in bytes that this ArrowBuf will provide access to.
357357
* @param manager
358358
* An optional BufferManager argument that can be used to manage expansion of this ArrowBuf
359-
* @param retain
360-
* Whether or not the newly created buffer should get an additional reference count added to it.
361359
* @return A new ArrowBuf that shares references with all ArrowBufs associated with this BufferLedger
362360
*/
363361
public ArrowBuf newArrowBuf(int offset, int length, BufferManager manager) {

java/memory/src/main/java/org/apache/arrow/memory/AllocatorClosedException.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,12 @@
2020
/**
2121
* Exception thrown when a closed BufferAllocator is used. Note
2222
* this is an unchecked exception.
23-
*
24-
* @param message string associated with the cause
2523
*/
2624
@SuppressWarnings("serial")
2725
public class AllocatorClosedException extends RuntimeException {
26+
/**
27+
* @param message string associated with the cause
28+
*/
2829
public AllocatorClosedException(String message) {
2930
super(message);
3031
}

java/memory/src/main/java/org/apache/arrow/memory/ChildAllocator.java

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,12 @@ class ChildAllocator extends BaseAllocator {
3131
* Constructor.
3232
*
3333
* @param parentAllocator parent allocator -- the one creating this child
34-
* @param allocatorOwner a handle to the object making the request
35-
* @param allocationPolicy the allocation policy to use; the policy for all
36-
* allocators must match for each invocation of a drillbit
34+
* @param name the name of this child allocator
3735
* @param initReservation initial amount of space to reserve (obtained from the parent)
3836
* @param maxAllocation maximum amount of space that can be obtained from this allocator;
3937
* note this includes direct allocations (via {@see BufferAllocator#buffer(int, int)}
4038
* et al) and requests from descendant allocators. Depending on the allocation policy in
4139
* force, even less memory may be available
42-
* @param flags one or more of BaseAllocator.F_* flags
4340
*/
4441
ChildAllocator(
4542
BaseAllocator parentAllocator,

java/memory/src/main/java/org/apache/arrow/memory/util/HistoricalLog.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ public void buildHistory(final StringBuilder sb, boolean includeStackTrace) {
126126
/**
127127
*
128128
* @param sb
129-
* @param indexLevel
129+
* @param indent
130130
* @param includeStackTrace
131131
*/
132132
public synchronized void buildHistory(final StringBuilder sb, int indent, boolean includeStackTrace) {

java/vector/src/main/java/org/apache/arrow/vector/AllocationHelper.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ public static void allocate(ValueVector v, int valueCount, int bytesPerValue, in
4949
* Allocates the exact amount if v is fixed width, otherwise falls back to dynamic allocation
5050
* @param v value vector we are trying to allocate
5151
* @param valueCount size we are trying to allocate
52-
* @throws org.apache.drill.exec.memory.OutOfMemoryException if it can't allocate the memory
52+
* @throws org.apache.arrow.memory.OutOfMemoryException if it can't allocate the memory
5353
*/
5454
public static void allocateNew(ValueVector v, int valueCount) {
5555
if (v instanceof FixedWidthVector) {

java/vector/src/main/java/org/apache/arrow/vector/complex/ContainerVectorLike.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ public interface ContainerVectorLike {
3131
*
3232
* @param descriptor vector descriptor
3333
* @return result of operation wrapping vector corresponding to the given descriptor and whether it's newly created
34-
* @throws org.apache.drill.common.exceptions.DrillRuntimeException
34+
* @throws org.apache.arrow.vector.util.SchemaChangeRuntimeException
3535
* if schema change is not permissible between the given and existing data vector types.
3636
*/
3737
<T extends ValueVector> AddOrGetResult<T> addOrGetVector(VectorDescriptor descriptor);

0 commit comments

Comments
 (0)