org.bytedeco.arrow

Class RecordBatchResult

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.RecordBatchResult

All Implemented Interfaces:

AutoCloseable

@Name(value="arrow::Result<std::shared_ptr<arrow::RecordBatch> >")
 @NoOffset
 @Properties(inherit=arrow.class)
public class RecordBatchResult
extends Pointer

Nested Class Summary

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
RecordBatchResult() Constructs a Result object that contains a non-OK status.
RecordBatchResult(long size) Native array allocator.
RecordBatchResult(Pointer p) Pointer cast constructor.
RecordBatchResult(RecordBatch value) Constructs a Result object that contains value.
RecordBatchResult(RecordBatchResult other) Copy constructor.
RecordBatchResult(Status status) Constructs a Result object with the given non-OK Status object.

Method Summary

Modifier and Type	Method and Description
boolean	Equals(RecordBatchResult other) Compare to another Result.
RecordBatchResult	getPointer(long i)
RecordBatch	MoveValueUnsafe()
RecordBatch	multiply()
boolean	ok() Indicates whether the object contains a T value.
RecordBatchResult	position(long position)
RecordBatchResult	put(RecordBatchResult other) Copy-assignment operator.
Status	status() Gets the stored status object, or an OK status if a T value is stored.
RecordBatch	ValueOrDie() Gets a mutable reference to the stored T value.
RecordBatch	ValueUnsafe() Apply a function to the internally stored value to produce a new result or propagate the stored error.

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

RecordBatchResult

public RecordBatchResult(Pointer p)

Pointer cast constructor. Invokes Pointer.Pointer(Pointer).

RecordBatchResult

public RecordBatchResult(long size)

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

RecordBatchResult

public RecordBatchResult()

Constructs a Result object that contains a non-OK status. This constructor is marked explicit to prevent attempts to return {} from a function with a return type of, for example, Result<std::vector<int>>. While return {} seems like it would return an empty vector, it will actually invoke the default constructor of Result.

RecordBatchResult

public RecordBatchResult(@Const @ByRef
                         Status status)

Constructs a Result object with the given non-OK Status object. All calls to ValueOrDie() on this object will abort. The given status must not be an OK status, otherwise this constructor will abort. This constructor is not declared explicit so that a function with a return type of Result<T> can return a Status object, and the status will be implicitly converted to the appropriate return type as a matter of convenience.

Parameters:

status - The non-OK Status object to initialize to.

RecordBatchResult

public RecordBatchResult(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::RecordBatch>"})
                         RecordBatch value)

Constructs a Result object that contains value. The resulting object is considered to have an OK status. The wrapped element can be accessed with ValueOrDie(). This constructor is made implicit so that a function with a return type of Result<T> can return an object of type T, implicitly converting it to a Result<T> object.

Parameters:

value - The value to initialize to.

RecordBatchResult

public RecordBatchResult(@Const @ByRef
                         RecordBatchResult other)

Copy constructor. This constructor needs to be explicitly defined because the presence of the move-assignment operator deletes the default copy constructor. In such a scenario, since the deleted copy constructor has stricter binding rules than the templated copy constructor, the templated constructor cannot act as a copy constructor, and any attempt to copy-construct a Result object results in a compilation error.

Parameters:

other - The value to copy from.

Method Detail

position

public RecordBatchResult position(long position)

Overrides:

position in class Pointer

getPointer

public RecordBatchResult getPointer(long i)

Overrides:

getPointer in class Pointer

put

@ByRef
 @Name(value="operator =")
public RecordBatchResult put(@Const @ByRef
                                                                 RecordBatchResult other)

Copy-assignment operator.

Parameters:

other - The Result object to copy.

Equals

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

Compare to another Result.

ok

@Cast(value="bool")
public boolean ok()

Indicates whether the object contains a T value. Generally instead of accessing this directly you will want to use ASSIGN_OR_RAISE defined below.

Returns:

True if this Result object's status is OK (i.e. a call to ok() returns true). If this function returns true, then it is safe to access the wrapped element through a call to ValueOrDie().

status

@Const
 @ByRef
public Status status()

Gets the stored status object, or an OK status if a T value is stored. /** /** @return The stored non-OK status object, or an OK status if this object /** has a value.

ValueOrDie

@SharedPtr
 @ByRef
public RecordBatch ValueOrDie()

Gets a mutable reference to the stored T value. This method should only be called if this Result object's status is OK (i.e. a call to ok() returns true), otherwise this call will abort.

Returns:

The stored T value.

multiply

@SharedPtr
 @ByRef
 @Name(value="operator *")
public RecordBatch multiply()

ValueUnsafe

@SharedPtr
 @ByRef
public RecordBatch ValueUnsafe()

Apply a function to the internally stored value to produce a new result or propagate the stored error.

MoveValueUnsafe

@SharedPtr
 @Cast(value={"","std::shared_ptr<arrow::RecordBatch>"})
public RecordBatch MoveValueUnsafe()