Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ARROW-10: Fix mismatch of javadoc names and method parameters #3

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down Expand Up @@ -356,8 +357,6 @@ public ArrowBuf newArrowBuf(int offset, int length) {
* The length in bytes that this ArrowBuf will provide access to.
* @param manager
* An optional BufferManager argument that can be used to manage expansion of this ArrowBuf
* @param retain
* Whether or not the newly created buffer should get an additional reference count added to it.
* @return A new ArrowBuf that shares references with all ArrowBufs associated with this BufferLedger
*/
public ArrowBuf newArrowBuf(int offset, int length, BufferManager manager) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*/
<T extends ValueVector> AddOrGetResult<T> addOrGetVector(VectorDescriptor descriptor);
Expand Down