org.bytedeco.arrow

Class Codec

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.Codec

All Implemented Interfaces:

AutoCloseable

@Namespace(value="arrow::util")
 @Properties(inherit=arrow.class)
public class Codec
extends Pointer

\brief Compression codec

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

Method Summary

Modifier and Type	Method and Description
LongResult	Compress(long input_len, byte[] input, long output_buffer_len, byte[] output_buffer)
LongResult	Compress(long input_len, ByteBuffer input, long output_buffer_len, ByteBuffer output_buffer)
LongResult	Compress(long input_len, BytePointer input, long output_buffer_len, BytePointer output_buffer) \brief One-shot compression function output_buffer_len must first have been computed using MaxCompressedLen().
int	compression_level() \brief This Codec's compression level, if applicable
Compression.type	compression_type() \brief This Codec's compression type
static CodecResult	Create(Compression.type codec)
static CodecResult	Create(Compression.type codec, int compression_level) \brief Create a codec for the given compression algorithm
static CodecResult	Create(int codec)
static CodecResult	Create(int codec, int compression_level)
LongResult	Decompress(long input_len, byte[] input, long output_buffer_len, byte[] output_buffer)
LongResult	Decompress(long input_len, ByteBuffer input, long output_buffer_len, ByteBuffer output_buffer)
LongResult	Decompress(long input_len, BytePointer input, long output_buffer_len, BytePointer output_buffer) \brief One-shot decompression function output_buffer_len must be correct and therefore be obtained in advance.
int	default_compression_level() \brief Return the default compression level
static IntResult	DefaultCompressionLevel(Compression.type codec) \brief Return the default compression level Note: This function creates a temporary Codec instance
static IntResult	DefaultCompressionLevel(int codec)
static String	GetCodecAsString(Compression.type t) \brief Return a string name for compression type
static BytePointer	GetCodecAsString(int t)
static CompressionTypeResult	GetCompressionType(BytePointer name)
static CompressionTypeResult	GetCompressionType(String name) \brief Return compression type for name (all upper case)
static boolean	IsAvailable(Compression.type codec) \brief Return true if support for indicated codec has been enabled
static boolean	IsAvailable(int codec)
CompressorResult	MakeCompressor() \brief Create a streaming compressor instance
DecompressorResult	MakeDecompressor() \brief Create a streaming compressor instance
long	MaxCompressedLen(long input_len, byte[] input)
long	MaxCompressedLen(long input_len, ByteBuffer input)
long	MaxCompressedLen(long input_len, BytePointer input)
int	maximum_compression_level() \brief Return the largest supported compression level
static IntResult	MaximumCompressionLevel(Compression.type codec) \brief Return the largest supported compression level for the codec Note: This function creates a temporary Codec instance
static IntResult	MaximumCompressionLevel(int codec)
int	minimum_compression_level() \brief Return the smallest supported compression level
static IntResult	MinimumCompressionLevel(Compression.type codec) \brief Return the smallest supported compression level for the codec Note: This function creates a temporary Codec instance
static IntResult	MinimumCompressionLevel(int codec)
String	name() \brief The name of this Codec's compression type
static boolean	SupportsCompressionLevel(Compression.type codec) \brief Return true if indicated codec supports setting a compression level
static boolean	SupportsCompressionLevel(int codec)
static int	UseDefaultCompressionLevel() \brief Return special value to indicate that a codec implementation should use its default compression level

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

Codec

public Codec(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

UseDefaultCompressionLevel

public static int UseDefaultCompressionLevel()

\brief Return special value to indicate that a codec implementation should use its default compression level

GetCodecAsString

@StdString
public static String GetCodecAsString(Compression.type t)

\brief Return a string name for compression type

GetCodecAsString

@StdString
public static BytePointer GetCodecAsString(@Cast(value="arrow::Compression::type")
                                                       int t)

GetCompressionType

@ByVal
public static CompressionTypeResult GetCompressionType(@StdString
                                                               String name)

\brief Return compression type for name (all upper case)

GetCompressionType

@ByVal
public static CompressionTypeResult GetCompressionType(@StdString
                                                               BytePointer name)

Create

@ByVal
public static CodecResult Create(Compression.type codec,
                                         int compression_level)

\brief Create a codec for the given compression algorithm

Create

@ByVal
public static CodecResult Create(Compression.type codec)

Create

@ByVal
public static CodecResult Create(@Cast(value="arrow::Compression::type")
                                         int codec,
                                         int compression_level)

Create

@ByVal
public static CodecResult Create(@Cast(value="arrow::Compression::type")
                                         int codec)

IsAvailable

@Cast(value="bool")
public static boolean IsAvailable(Compression.type codec)

\brief Return true if support for indicated codec has been enabled

IsAvailable

@Cast(value="bool")
public static boolean IsAvailable(@Cast(value="arrow::Compression::type")
                                                       int codec)

SupportsCompressionLevel

@Cast(value="bool")
public static boolean SupportsCompressionLevel(Compression.type codec)

\brief Return true if indicated codec supports setting a compression level

SupportsCompressionLevel

@Cast(value="bool")
public static boolean SupportsCompressionLevel(@Cast(value="arrow::Compression::type")
                                                                    int codec)

MinimumCompressionLevel

@ByVal
public static IntResult MinimumCompressionLevel(Compression.type codec)

\brief Return the smallest supported compression level for the codec Note: This function creates a temporary Codec instance

MinimumCompressionLevel

@ByVal
public static IntResult MinimumCompressionLevel(@Cast(value="arrow::Compression::type")
                                                        int codec)

MaximumCompressionLevel

@ByVal
public static IntResult MaximumCompressionLevel(Compression.type codec)

\brief Return the largest supported compression level for the codec Note: This function creates a temporary Codec instance

MaximumCompressionLevel

@ByVal
public static IntResult MaximumCompressionLevel(@Cast(value="arrow::Compression::type")
                                                        int codec)

DefaultCompressionLevel

@ByVal
public static IntResult DefaultCompressionLevel(Compression.type codec)

\brief Return the default compression level Note: This function creates a temporary Codec instance

DefaultCompressionLevel

@ByVal
public static IntResult DefaultCompressionLevel(@Cast(value="arrow::Compression::type")
                                                        int codec)

minimum_compression_level

public int minimum_compression_level()

\brief Return the smallest supported compression level

maximum_compression_level

public int maximum_compression_level()

\brief Return the largest supported compression level

default_compression_level

public int default_compression_level()

\brief Return the default compression level

Decompress

@ByVal
public LongResult Decompress(@Cast(value="int64_t")
                                     long input_len,
                                     @Cast(value="const uint8_t*")
                                     BytePointer input,
                                     @Cast(value="int64_t")
                                     long output_buffer_len,
                                     @Cast(value="uint8_t*")
                                     BytePointer output_buffer)

\brief One-shot decompression function output_buffer_len must be correct and therefore be obtained in advance. The actual decompressed length is returned. \note One-shot decompression is not always compatible with streaming compression. Depending on the codec (e.g. LZ4), different formats may be used.

Decompress

@ByVal
public LongResult Decompress(@Cast(value="int64_t")
                                     long input_len,
                                     @Cast(value="const uint8_t*")
                                     ByteBuffer input,
                                     @Cast(value="int64_t")
                                     long output_buffer_len,
                                     @Cast(value="uint8_t*")
                                     ByteBuffer output_buffer)

Decompress

@ByVal
public LongResult Decompress(@Cast(value="int64_t")
                                     long input_len,
                                     @Cast(value="const uint8_t*")
                                     byte[] input,
                                     @Cast(value="int64_t")
                                     long output_buffer_len,
                                     @Cast(value="uint8_t*")
                                     byte[] output_buffer)

Compress

@ByVal
public LongResult Compress(@Cast(value="int64_t")
                                   long input_len,
                                   @Cast(value="const uint8_t*")
                                   BytePointer input,
                                   @Cast(value="int64_t")
                                   long output_buffer_len,
                                   @Cast(value="uint8_t*")
                                   BytePointer output_buffer)

\brief One-shot compression function output_buffer_len must first have been computed using MaxCompressedLen(). The actual compressed length is returned. \note One-shot compression is not always compatible with streaming decompression. Depending on the codec (e.g. LZ4), different formats may be used.

Compress

@ByVal
public LongResult Compress(@Cast(value="int64_t")
                                   long input_len,
                                   @Cast(value="const uint8_t*")
                                   ByteBuffer input,
                                   @Cast(value="int64_t")
                                   long output_buffer_len,
                                   @Cast(value="uint8_t*")
                                   ByteBuffer output_buffer)

Compress

@ByVal
public LongResult Compress(@Cast(value="int64_t")
                                   long input_len,
                                   @Cast(value="const uint8_t*")
                                   byte[] input,
                                   @Cast(value="int64_t")
                                   long output_buffer_len,
                                   @Cast(value="uint8_t*")
                                   byte[] output_buffer)

MaxCompressedLen

@Cast(value="int64_t")
public long MaxCompressedLen(@Cast(value="int64_t")
                                                     long input_len,
                                                     @Cast(value="const uint8_t*")
                                                     BytePointer input)

MaxCompressedLen

@Cast(value="int64_t")
public long MaxCompressedLen(@Cast(value="int64_t")
                                                     long input_len,
                                                     @Cast(value="const uint8_t*")
                                                     ByteBuffer input)

MaxCompressedLen

@Cast(value="int64_t")
public long MaxCompressedLen(@Cast(value="int64_t")
                                                     long input_len,
                                                     @Cast(value="const uint8_t*")
                                                     byte[] input)

MakeCompressor

@ByVal
public CompressorResult MakeCompressor()

\brief Create a streaming compressor instance

MakeDecompressor

@ByVal
public DecompressorResult MakeDecompressor()

\brief Create a streaming compressor instance

compression_type

public Compression.type compression_type()

\brief This Codec's compression type

name

@StdString
public String name()

\brief The name of this Codec's compression type

compression_level

public int compression_level()

\brief This Codec's compression level, if applicable