org.bytedeco.arrow

Class Status

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.Status

All Implemented Interfaces:

AutoCloseable

@Namespace(value="arrow")
 @NoOffset
 @Properties(inherit=arrow.class)
public class Status
extends Pointer

\brief Status outcome object (success or error) The Status object is an object holding the outcome of an operation. The outcome is represented as a StatusCode, either success (StatusCode::OK) or an error (any other of the StatusCode enumeration values). Additionally, if an error occurred, a specific error message is generally attached.

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
Status()
Status(arrow.StatusCode code, String msg)
Status(arrow.StatusCode code, String msg, StatusDetail detail) \brief Pluggable constructor for use by sub-systems.
Status(byte code, BytePointer msg)
Status(byte code, BytePointer msg, StatusDetail detail)
Status(long size) Native array allocator.
Status(Pointer p) Pointer cast constructor.
Status(Status s)

Method Summary

Modifier and Type	Method and Description
void	Abort(BytePointer message)
void	Abort(String message) \brief Return a new Status with changed message, copying the existing status code and detail.
Status	and(Status s)
Status	andPut(Status s)
arrow.StatusCode	code() \brief Return the StatusCode value attached to this status.
String	CodeAsString() \brief Return a string representation of the status code, without the message text or POSIX code information.
static String	CodeAsString(arrow.StatusCode arg0)
static BytePointer	CodeAsString(byte arg0)
StatusDetail	detail() \brief Return the status detail attached to this message.
boolean	Equals(Status s)
Status	getPointer(long i)
boolean	IsAlreadyExists()
boolean	IsCapacityError() Return true iff the status indicates a container reaching capacity limits.
boolean	IsCodeGenError()
boolean	IsExecutionError()
boolean	IsExpressionValidationError()
boolean	IsIndexError() Return true iff the status indicates an out of bounds index.
boolean	IsInvalid() Return true iff the status indicates invalid data.
boolean	IsIOError() Return true iff the status indicates an IO-related failure.
boolean	IsKeyError() Return true iff the status indicates a key lookup error.
boolean	IsNotImplemented() Return true iff the status indicates an unimplemented operation.
boolean	IsOutOfMemory() Return true iff the status indicates an out-of-memory error.
boolean	IsRError() Return true iff the status indicates a R-originated error.
boolean	IsSerializationError() Return true iff the status indicates a (de)serialization failure
boolean	IsTypeError() Return true iff the status indicates a type error.
boolean	IsUnknownError() Return true iff the status indicates an unknown error.
String	message() \brief Return the specific error message attached to this status.
boolean	ok() Return true iff the status indicates success.
static Status	OK() Return a success status
Status	position(long position)
Status	put(Status s)
String	ToString() \brief Return a string representation of this status suitable for printing.
Status	WithDetail(StatusDetail new_detail) \brief Return a new Status copying the existing status, but updating with the existing detail.

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

Status

public Status(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Status

public Status(long size)

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

Status

public Status()

Status

public Status(arrow.StatusCode code,
              @StdString
              String msg)

Status

public Status(@Cast(value="arrow::StatusCode")
              byte code,
              @StdString
              BytePointer msg)

Status

public Status(arrow.StatusCode code,
              @StdString
              String msg,
              @SharedPtr
              StatusDetail detail)

\brief Pluggable constructor for use by sub-systems. detail cannot be null.

Status

public Status(@Cast(value="arrow::StatusCode")
              byte code,
              @StdString
              BytePointer msg,
              @SharedPtr
              StatusDetail detail)

Status

public Status(@Const @ByRef
              Status s)

Method Detail

position

public Status position(long position)

Overrides:

position in class Pointer

getPointer

public Status getPointer(long i)

Overrides:

getPointer in class Pointer

put

@ByRef
 @Name(value="operator =")
public Status put(@Const @ByRef
                                                      Status s)

Equals

@Cast(value="bool")
public boolean Equals(@Const @ByRef
                                           Status s)

and

@ByVal
 @Name(value="operator &")
 @NoException
public Status and(@Const @ByRef
                                                                     Status s)

andPut

@ByRef
 @Name(value="operator &=")
 @NoException
public Status andPut(@Const @ByRef
                                                                         Status s)

OK

@ByVal
public static Status OK()

Return a success status

ok

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

Return true iff the status indicates success.

IsOutOfMemory

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

Return true iff the status indicates an out-of-memory error.

IsKeyError

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

Return true iff the status indicates a key lookup error.

IsInvalid

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

Return true iff the status indicates invalid data.

IsIOError

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

Return true iff the status indicates an IO-related failure.

IsCapacityError

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

Return true iff the status indicates a container reaching capacity limits.

IsIndexError

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

Return true iff the status indicates an out of bounds index.

IsTypeError

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

Return true iff the status indicates a type error.

IsUnknownError

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

Return true iff the status indicates an unknown error.

IsNotImplemented

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

Return true iff the status indicates an unimplemented operation.

IsSerializationError

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

Return true iff the status indicates a (de)serialization failure

IsRError

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

Return true iff the status indicates a R-originated error.

IsCodeGenError

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

IsExpressionValidationError

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

IsExecutionError

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

IsAlreadyExists

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

ToString

@StdString
public String ToString()

\brief Return a string representation of this status suitable for printing. The string "OK" is returned for success.

CodeAsString

@StdString
public String CodeAsString()

\brief Return a string representation of the status code, without the message text or POSIX code information.

CodeAsString

@StdString
public static String CodeAsString(arrow.StatusCode arg0)

CodeAsString

@StdString
public static BytePointer CodeAsString(@Cast(value="arrow::StatusCode")
                                                   byte arg0)

code

public arrow.StatusCode code()

\brief Return the StatusCode value attached to this status.

message

@StdString
public String message()

\brief Return the specific error message attached to this status.

detail

@SharedPtr
public StatusDetail detail()

\brief Return the status detail attached to this message.

WithDetail

@ByVal
public Status WithDetail(@SharedPtr
                                 StatusDetail new_detail)

\brief Return a new Status copying the existing status, but updating with the existing detail.

Abort

public void Abort(@StdString
                  String message)

\brief Return a new Status with changed message, copying the existing status code and detail.

Abort

public void Abort(@StdString
                  BytePointer message)