org.bytedeco.arrow

Class DatumResult

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.DatumResult

All Implemented Interfaces:

AutoCloseable

@Name(value="arrow::Result<arrow::Datum>")
 @NoOffset
 @Properties(inherit=arrow.class)
public class DatumResult
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
DatumResult() Constructs a Result object that contains a non-OK status.
DatumResult(Datum value) Constructs a Result object that contains value.
DatumResult(DatumResult other) Copy constructor.
DatumResult(long size) Native array allocator.
DatumResult(Pointer p) Pointer cast constructor.
DatumResult(Status status) Constructs a Result object with the given non-OK Status object.

Method Summary

Modifier and Type	Method and Description
Datum	access()
DatumResult	getPointer(long i)
Datum	MoveValueUnsafe()
Datum	multiply()
boolean	ok() Indicates whether the object contains a T value.
DatumResult	position(long position)
DatumResult	put(DatumResult other) Copy-assignment operator.
Status	status() Gets the stored status object, or an OK status if a T value is stored.
Datum	ValueOrDie() Gets a mutable reference to the stored T value.
Datum	ValueUnsafe() Cast 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, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, 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

DatumResult

public DatumResult(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

DatumResult

public DatumResult(long size)

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

DatumResult

public DatumResult()

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.

DatumResult

public DatumResult(@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.

DatumResult

public DatumResult(@ByRef(value=true)
                   Datum 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.

DatumResult

public DatumResult(@Const @ByRef
                   DatumResult 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 DatumResult position(long position)

Overrides:

position in class Pointer

getPointer

public DatumResult getPointer(long i)

Overrides:

getPointer in class Pointer

put

@ByRef
 @Name(value="operator =")
 @NoException(value=true)
public DatumResult put(@Const @ByRef
                                                                                      DatumResult other)

Copy-assignment operator.

Parameters:

other - The Result object to copy.

ok

@Cast(value="const 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

@ByRef
public Datum 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

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

access

@Name(value="operator ->")
public Datum access()

ValueUnsafe

@Const
 @ByRef
public Datum ValueUnsafe()

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

MoveValueUnsafe

@ByVal
public Datum MoveValueUnsafe()