org.bytedeco.arrow

Class FunctionDoc

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.FunctionDoc

All Implemented Interfaces:

AutoCloseable

@Namespace(value="arrow::compute")
 @NoOffset
 @Properties(inherit=arrow.class)
public class FunctionDoc
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
FunctionDoc()
FunctionDoc(BytePointer summary, BytePointer description, StringVector arg_names)
FunctionDoc(BytePointer summary, BytePointer description, StringVector arg_names, BytePointer options_class)
FunctionDoc(long size) Native array allocator.
FunctionDoc(Pointer p) Pointer cast constructor.
FunctionDoc(String summary, String description, StringVector arg_names)
FunctionDoc(String summary, String description, StringVector arg_names, String options_class)

Method Summary

Modifier and Type	Method and Description
StringVector	arg_names() \brief Symbolic names (identifiers) for the function arguments.
FunctionDoc	arg_names(StringVector setter)
String	description() \brief A detailed description of the function, meant to follow the summary.
FunctionDoc	description(String setter)
static FunctionDoc	Empty()
FunctionDoc	getPointer(long i)
String	options_class() \brief Name of the options class, if any.
FunctionDoc	options_class(String setter)
FunctionDoc	position(long position)
String	summary() \brief A one-line summary of the function, using a verb.
FunctionDoc	summary(String setter)

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

FunctionDoc

public FunctionDoc(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

FunctionDoc

public FunctionDoc(long size)

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

FunctionDoc

public FunctionDoc()

FunctionDoc

public FunctionDoc(@StdString
                   String summary,
                   @StdString
                   String description,
                   @ByVal
                   StringVector arg_names,
                   @StdString
                   String options_class)

FunctionDoc

public FunctionDoc(@StdString
                   String summary,
                   @StdString
                   String description,
                   @ByVal
                   StringVector arg_names)

FunctionDoc

public FunctionDoc(@StdString
                   BytePointer summary,
                   @StdString
                   BytePointer description,
                   @ByVal
                   StringVector arg_names,
                   @StdString
                   BytePointer options_class)

FunctionDoc

public FunctionDoc(@StdString
                   BytePointer summary,
                   @StdString
                   BytePointer description,
                   @ByVal
                   StringVector arg_names)

Method Detail

position

public FunctionDoc position(long position)

Overrides:

position in class Pointer

getPointer

public FunctionDoc getPointer(long i)

Overrides:

getPointer in class Pointer

summary

@StdString
public String summary()

\brief A one-line summary of the function, using a verb. For example, "Add two numeric arrays or scalars".

summary

public FunctionDoc summary(String setter)

description

@StdString
public String description()

\brief A detailed description of the function, meant to follow the summary.

description

public FunctionDoc description(String setter)

arg_names

@ByRef
public StringVector arg_names()

\brief Symbolic names (identifiers) for the function arguments. Some bindings may use this to generate nicer function signatures.

arg_names

public FunctionDoc arg_names(StringVector setter)

options_class

@StdString
public String options_class()

\brief Name of the options class, if any.

options_class

public FunctionDoc options_class(String setter)

Empty

@Const
 @ByRef
public static FunctionDoc Empty()