org.bytedeco.arrow

Class BufferIterator

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.BufferIterator

All Implemented Interfaces:

AutoCloseable

@Name(value="arrow::Iterator<std::shared_ptr<arrow::Buffer> >")
 @NoOffset
 @Properties(inherit=arrow.class)
public class BufferIterator
extends Pointer

\brief A generic Iterator that can return errors

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BufferIterator.RangeIterator

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
BufferIterator() \brief Iterator may be constructed from any type which has a member function with signature Status Next(T*); The argument is moved or copied to the heap and kept in a unique_ptr.
BufferIterator(long size) Native array allocator.
BufferIterator(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
boolean	asBoolean()
BufferIterator.RangeIterator	begin()
BufferIterator.RangeIterator	end()
boolean	Equals(BufferIterator other) Iterators will only compare equal if they are both null.
BufferIterator	getPointer(long i)
BufferResult	Next() \brief Return the next element of the sequence, IterationTraits::End() when the iteration is completed.
BufferIterator	position(long position)
BufferVectorResult	ToVector() \brief Move every element of this iterator into a vector.

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getPointer, getPointer, getPointer, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, offsetof, parseBytes, physicalBytes, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BufferIterator

public BufferIterator(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

BufferIterator

public BufferIterator(long size)

Native array allocator. Access with Pointer.position(long).

BufferIterator

public BufferIterator()

\brief Iterator may be constructed from any type which has a member function with signature Status Next(T*); The argument is moved or copied to the heap and kept in a unique_ptr. Only its destructor and its Next method (which are stored in function pointers) are referenced after construction. This approach is used to dodge MSVC linkage hell (ARROW-6244, ARROW-6558) when using an abstract template base class: instead of being inlined as usual for a template function the base's virtual destructor will be exported, leading to multiple definition errors when linking to any other TU where the base is instantiated.

Method Detail

position

public BufferIterator position(long position)

Overrides:

position in class Pointer

getPointer

public BufferIterator getPointer(long i)

Overrides:

getPointer in class Pointer

Next

@ByVal
public BufferResult Next()

\brief Return the next element of the sequence, IterationTraits::End() when the iteration is completed. Calling this on a default constructed Iterator will result in undefined behavior.

Equals

@Cast(value="bool")
public boolean Equals(@Const @ByRef
                                           BufferIterator other)

Iterators will only compare equal if they are both null. Equality comparability is required to make an Iterator of Iterators (to check for the end condition).

asBoolean

@Cast(value="bool")
 @Name(value="operator bool")
public boolean asBoolean()

begin

@ByVal
public BufferIterator.RangeIterator begin()

end

@ByVal
public BufferIterator.RangeIterator end()

ToVector

@ByVal
public BufferVectorResult ToVector()

\brief Move every element of this iterator into a vector.