org.bytedeco.arrow

Class FunctionOptions

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.FunctionOptions

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

ArithmeticOptions, ArraySortOptions, AssumeTimezoneOptions, CastOptions, CountOptions, DayOfWeekOptions, DictionaryEncodeOptions, ElementWiseAggregateOptions, ExtractRegexOptions, FilterOptions, IndexOptions, JoinOptions, MakeStructOptions, MatchSubstringOptions, ModeOptions, NullOptions, PadOptions, PartitionNthOptions, QuantileOptions, ReplaceSliceOptions, ReplaceSubstringOptions, RoundOptions, RoundToMultipleOptions, ScalarAggregateOptions, SelectKOptions, SetLookupOptions, SliceOptions, SortOptions, SplitOptions, SplitPatternOptions, StrftimeOptions, StrptimeOptions, TakeOptions, TDigestOptions, TrimOptions, VarianceOptions, WeekOptions

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

\brief Base class for specifying options configuring a function's behavior, such as error handling.

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
FunctionOptions(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
FunctionOptions	Copy()
static FunctionOptionsResult	Deserialize(BytePointer type_name, ArrowBuffer buffer)
static FunctionOptionsResult	Deserialize(String type_name, ArrowBuffer buffer) \brief Deserialize an options struct from a buffer.
boolean	Equals(FunctionOptions other)
FunctionOptionsType	options_type()
BufferResult	Serialize() \brief Serialize an options struct to a buffer.
String	ToString()
String	type_name()

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, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, position, 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

FunctionOptions

public FunctionOptions(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

options_type

@Const
public FunctionOptionsType options_type()

type_name

public String type_name()

Equals

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

ToString

@StdString
public String ToString()

Copy

@UniquePtr
public FunctionOptions Copy()

Serialize

@ByVal
public BufferResult Serialize()

\brief Serialize an options struct to a buffer.

Deserialize

@ByVal
public static FunctionOptionsResult Deserialize(@StdString
                                                        String type_name,
                                                        @Const @ByRef
                                                        ArrowBuffer buffer)

\brief Deserialize an options struct from a buffer. Note: this will only look for type_name in the default FunctionRegistry; to use a custom FunctionRegistry, look up the FunctionOptionsType, then call FunctionOptionsType::Deserialize().

Deserialize

@ByVal
public static FunctionOptionsResult Deserialize(@StdString
                                                        BytePointer type_name,
                                                        @Const @ByRef
                                                        ArrowBuffer buffer)