org.bytedeco.arrow_dataset

Class EnumeratedRecordBatchIterator

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow_dataset.EnumeratedRecordBatchIterator

All Implemented Interfaces:

AutoCloseable

@Name(value="arrow::Iterator<arrow::dataset::EnumeratedRecordBatch>")
 @NoOffset
 @Properties(inherit=arrow_dataset.class)
public class EnumeratedRecordBatchIterator
extends Pointer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EnumeratedRecordBatchIterator.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
EnumeratedRecordBatchIterator() \brief Iterator may be constructed from any type which has a member function with signature Result Next(); End of iterator is signalled by returning IteratorTraits::End(); The argument is moved or copied to the heap and kept in a unique_ptr.
EnumeratedRecordBatchIterator(long size) Native array allocator.
EnumeratedRecordBatchIterator(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
boolean	asBoolean()
EnumeratedRecordBatchIterator.RangeIterator	begin()
EnumeratedRecordBatchIterator.RangeIterator	end()
boolean	Equals(EnumeratedRecordBatchIterator other) Iterators will only compare equal if they are both null.
EnumeratedRecordBatchIterator	getPointer(long i)
TaggedRecordBatchResult	Next() \brief Return the next element of the sequence, IterationTraits::End() when the iteration is completed.
EnumeratedRecordBatchIterator	position(long position)
EnumeratedRecordBatchResult	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, getDirectBufferAddress, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, 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

EnumeratedRecordBatchIterator

public EnumeratedRecordBatchIterator(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

EnumeratedRecordBatchIterator

public EnumeratedRecordBatchIterator(long size)

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

EnumeratedRecordBatchIterator

public EnumeratedRecordBatchIterator()

\brief Iterator may be constructed from any type which has a member function with signature Result Next(); End of iterator is signalled by returning IteratorTraits::End(); 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 EnumeratedRecordBatchIterator position(long position)

Overrides:

position in class Pointer

getPointer

public EnumeratedRecordBatchIterator getPointer(long i)

Overrides:

getPointer in class Pointer

Next

@ByVal
public TaggedRecordBatchResult 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
                                           EnumeratedRecordBatchIterator 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 EnumeratedRecordBatchIterator.RangeIterator begin()

end

@ByVal
public EnumeratedRecordBatchIterator.RangeIterator end()

ToVector

@ByVal
public EnumeratedRecordBatchResult ToVector()

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