Compression Java Reference Documentation

CkCompression

Current Version: 11.4.0

Provides a flexible and efficient API for compressing and decompressing data in memory, files, and streams. It supports multiple compression algorithms, chunked processing for large data, and optional encoding for easy transport or storage.


Key Features

  • Multiple Compression Algorithms
    • deflate
    • zlib (deflate with header)
    • bzip2
    • lzw
  • Flexible Data Types
    • Byte arrays
    • Strings (with configurable charset)
    • BinData and StringBuilder
    • Files and streams
  • Streaming Support
    • Compress/decompress arbitrarily large data with constant memory usage
    • Ideal for files, sockets, or continuous data streams
  • Chunked Processing
    • Process data incrementally using FirstChunk and LastChunk
    • Replace older Begin/More/End patterns
  • Encoded Output Options
  • Integrated Compression + Encryption
    • Combine compression and encryption in a single operation

Object Creation

CkCompression obj = new CkCompression();

Properties

Algorithm
void get_Algorithm(CkString str);
String algorithm();
void put_Algorithm(String newVal);

Specifies the compression algorithm to use. Supported values are deflate, zlib, bzip2, and lzw.

The zlib option is the deflate algorithm with a zlib header.

Note: ppmd is deprecated and should not be used. It was only available on 32-bit systems and specifically used the J variant. New applications should use one of the supported algorithms listed above.

top
Charset
void get_Charset(CkString str);
String charset();
void put_Charset(String newVal);

Specifies the character encoding used when converting text to bytes before compression, and bytes back to text after decompression.

The current default is the computer’s ANSI charset, such as Windows-1252 on many Western Windows systems. However, most modern applications should explicitly set this property to utf-8.

Recommendation: Set Charset = "utf-8" unless you specifically need compatibility with another encoding.

top
DebugLogFilePath
void get_DebugLogFilePath(CkString str);
String debugLogFilePath();
void put_DebugLogFilePath(String newVal);

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

  • A timeout property set to 0, indicating an infinite timeout.
  • A hang occurring within an event callback in the application code.
  • An internal bug in the Chilkat code causing the hang.

top
DeflateLevel
int get_DeflateLevel();
void put_DeflateLevel(int newVal);
Introduced in version 9.5.0.73

Sets the compression level used by the deflate and zlib algorithms.

  • 0 means no compression.
  • 9 means maximum compression.
  • The default value is 6.

Higher values may produce smaller output but can require more processing time.

top
EncodingMode
void get_EncodingMode(CkString str);
String encodingMode();
void put_EncodingMode(String newVal);

Specifies the text encoding used by methods whose names end in ENC, such as CompressBytesENC and DecompressStringENC.

Compression methods ending in ENC return compressed binary data as an encoded string. Decompression methods ending in ENC expect the input string to use this same encoding.

Valid values include:

  • base64
  • hex
  • url
  • quoted-printable

More Information and Examples
top
FirstChunk
boolean get_FirstChunk();
void put_FirstChunk(boolean newVal);
Introduced in version 11.0.0

Indicates that the next chunk-aware compression or decompression call is the first chunk in a sequence.

The default value is true.

When both FirstChunk and LastChunk are true, the method call is treated as a complete, single-call compression or decompression operation.

top
HeartbeatMs
int get_HeartbeatMs();
void put_HeartbeatMs(int newVal);

Specifies the interval, in milliseconds, between AbortCheck event callbacks.

This allows an application to periodically check whether a long-running operation should be aborted.

The default value is 0, which disables AbortCheck callbacks.

More Information and Examples
top
LastChunk
boolean get_LastChunk();
void put_LastChunk(boolean newVal);
Introduced in version 11.0.0

Indicates that the next chunk-aware compression or decompression call is the final chunk in a sequence.

The default value is true.

When both FirstChunk and LastChunk are true, the input is treated as the complete data set and processed in a single call.

top
LastErrorHtml
void get_LastErrorHtml(CkString str);
String lastErrorHtml();

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastErrorText
void get_LastErrorText(CkString str);
String lastErrorText();

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastErrorXml
void get_LastErrorXml(CkString str);
String lastErrorXml();

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastMethodSuccess
boolean get_LastMethodSuccess();
void put_LastMethodSuccess(boolean newVal);

Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.

top
UncommonOptions
void get_UncommonOptions(CkString str);
String uncommonOptions();
void put_UncommonOptions(String newVal);
Introduced in version 11.0.0

Provides a way to enable specialized or uncommon behavior. This property normally remains empty.

It may be set to a comma-separated list of keywords.

Supported option:

  • Crypt2CompressHdr — Duplicates the compression/decompression header behavior used by the deprecated and removed Crypt2 compression functions.

top
VerboseLogging
boolean get_VerboseLogging();
void put_VerboseLogging(boolean newVal);

If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
void get_Version(CkString str);
String version();

Version of the component/library, such as "10.1.0"

top

Methods

CompressBd
boolean CompressBd(CkBinData bd);
Introduced in version 9.5.0.66

Compresses the data contained in a BinData object.

The BinData object is modified to contain the compressed result.

This method is not FirstChunk / LastChunk aware.

Returns true for success, false for failure.

top
CompressBdAsync (Android™) (Java)
CkTask CompressBdAsync(CkBinData bd);
Introduced in version 9.5.0.66

Creates an asynchronous task to call the CompressBd method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
CompressBd2
boolean CompressBd2(CkBinData bdIn, CkBinData bdOut);
Introduced in version 11.0.0

Compresses the data in one BinData object and appends the compressed output to another BinData object.

The input BinData is not modified.

This method is FirstChunk / LastChunk aware.

Returns true for success, false for failure.

top
CompressBd2Async (Android™) (Java)
CkTask CompressBd2Async(CkBinData bdIn, CkBinData bdOut);
Introduced in version 11.0.0

Creates an asynchronous task to call the CompressBd2 method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
CompressEncryptFile
boolean CompressEncryptFile(CkJsonObject cryptParams, String srcPath, String destPath);
Introduced in version 9.5.0.99

Compresses and encrypts a file, writing the result to a destination file.

The compression and encryption are performed internally in streaming mode, so files of any size can be processed without loading the entire file into memory.

Returns true for success, false for failure.

top
CompressEncryptFileAsync (Android™) (Java)
CkTask CompressEncryptFileAsync(CkJsonObject cryptParams, String srcPath, String destPath);
Introduced in version 9.5.0.99

Creates an asynchronous task to call the CompressEncryptFile method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
CompressFile
boolean CompressFile(String srcPath, String destPath);

Compresses a source file and writes the compressed data to a destination file.

The file is processed internally in streaming mode, allowing files of any size to be compressed with stable memory usage.

Returns true for success, false for failure.

top
CompressFileAsync (Android™) (Java)
CkTask CompressFileAsync(String srcPath, String destPath);

Creates an asynchronous task to call the CompressFile method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
CompressSb
boolean CompressSb(CkStringBuilder sb, CkBinData binData);
Introduced in version 9.5.0.73

Compresses the text contained in a StringBuilder and appends the compressed bytes to a BinData object.

Text is converted to bytes according to the Charset property.

This method is FirstChunk / LastChunk aware.

Returns true for success, false for failure.

top
CompressSbAsync (Android™) (Java)
CkTask CompressSbAsync(CkStringBuilder sb, CkBinData binData);
Introduced in version 9.5.0.73

Creates an asynchronous task to call the CompressSb method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
CompressStream
boolean CompressStream(CkStream strm);
Introduced in version 9.5.0.56

Compresses data from a stream source and writes the compressed data to the stream sink.

The operation is performed in streaming mode, making it suitable for very large or even continuous streams while maintaining stable memory usage.

Returns true for success, false for failure.

top
CompressStreamAsync (Android™) (Java)
CkTask CompressStreamAsync(CkStream strm);
Introduced in version 9.5.0.56

Creates an asynchronous task to call the CompressStream method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
CompressStringENC
boolean CompressStringENC(String str, CkString outStr);
String compressStringENC(String str);

Compresses a string and returns the compressed result as an encoded string.

The string is first converted to bytes using Charset, then compressed, and finally encoded according to EncodingMode.

This method is not FirstChunk / LastChunk aware.

Returns true for success, false for failure.

top
CompressStringENCAsync (Android™) (Java)
CkTask CompressStringENCAsync(String str);

Creates an asynchronous task to call the CompressStringENC method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
DecompressBd
boolean DecompressBd(CkBinData bd);
Introduced in version 9.5.0.66

Decompresses the compressed data contained in a BinData object.

The BinData object is modified to contain the decompressed result.

This method is not FirstChunk / LastChunk aware.

Returns true for success, false for failure.

top
DecompressBdAsync (Android™) (Java)
CkTask DecompressBdAsync(CkBinData bd);
Introduced in version 9.5.0.66

Creates an asynchronous task to call the DecompressBd method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
DecompressBd2
boolean DecompressBd2(CkBinData bdIn, CkBinData bdOut);
Introduced in version 11.0.0

Decompresses the data in one BinData object and appends the decompressed output to another BinData object.

The input BinData is not modified.

This method is FirstChunk / LastChunk aware.

Returns true for success, false for failure.

top
DecompressBd2Async (Android™) (Java)
CkTask DecompressBd2Async(CkBinData bdIn, CkBinData bdOut);
Introduced in version 11.0.0

Creates an asynchronous task to call the DecompressBd2 method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
DecompressFile
boolean DecompressFile(String srcPath, String destPath);

Decompresses a source file and writes the decompressed data to a destination file.

The file is processed internally in streaming mode, allowing files of any size to be decompressed without loading the entire file into memory.

Returns true for success, false for failure.

top
DecompressFileAsync (Android™) (Java)
CkTask DecompressFileAsync(String srcPath, String destPath);

Creates an asynchronous task to call the DecompressFile method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
DecompressSb
boolean DecompressSb(CkBinData binData, CkStringBuilder sb);
Introduced in version 9.5.0.73

Decompresses compressed data from a BinData object and appends the resulting text to a StringBuilder.

The decompressed bytes are converted to text using the Charset property.

This method is FirstChunk / LastChunk aware.

Returns true for success, false for failure.

top
DecompressSbAsync (Android™) (Java)
CkTask DecompressSbAsync(CkBinData binData, CkStringBuilder sb);
Introduced in version 9.5.0.73

Creates an asynchronous task to call the DecompressSb method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
DecompressStream
boolean DecompressStream(CkStream strm);
Introduced in version 9.5.0.56

Decompresses data from a stream source and writes the decompressed data to the stream sink.

The operation is performed in streaming mode, making it suitable for very large or continuous streams while maintaining stable memory usage.

Returns true for success, false for failure.

top
DecompressStreamAsync (Android™) (Java)
CkTask DecompressStreamAsync(CkStream strm);
Introduced in version 9.5.0.56

Creates an asynchronous task to call the DecompressStream method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
DecompressStringENC
boolean DecompressStringENC(String encodedCompressedData, CkString outStr);
String decompressStringENC(String encodedCompressedData);

Decompresses compressed data supplied as an encoded string and returns the resulting text.

The input string is decoded according to EncodingMode, then decompressed. The resulting bytes are converted to text using Charset.

This method is not FirstChunk / LastChunk aware.

Returns true for success, false for failure.

top
DecompressStringENCAsync (Android™) (Java)
CkTask DecompressStringENCAsync(String encodedCompressedData);

Creates an asynchronous task to call the DecompressStringENC method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
DecryptDecompressFile
boolean DecryptDecompressFile(CkJsonObject cryptParams, String srcPath, String destPath);
Introduced in version 9.5.0.99

Decrypts and decompresses a file, writing the restored data to a destination file.

This is the reverse operation of CompressEncryptFile.

Returns true for success, false for failure.

top
DecryptDecompressFileAsync (Android™) (Java)
CkTask DecryptDecompressFileAsync(CkJsonObject cryptParams, String srcPath, String destPath);
Introduced in version 9.5.0.99

Creates an asynchronous task to call the DecryptDecompressFile method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
LoadTaskCaller
boolean LoadTaskCaller(CkTask task);
Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns true for success, false for failure.

top

Events

Chilkat supports event callbacks in Java (including Android) starting in version 9.5.0.52. To implement an event callback, your application would define and implement a class that derives from CkBaseProgress. Your application can implement methods to override some or all of the default/empty method implementations of the CkBaseProgress base class.

For example:

// Install an event callback handler to get progress events.
MyBaseProgress compressionProgress = new MyBaseProgress();
http.put_EventCallbackObject(compressionProgress);

MyBaseProgress example:

import com.chilkatsoft.CkBaseProgress;
import com.chilkatsoft.CkTask;

public class MyBaseProgress extends CkBaseProgress 
{	
  public boolean AbortCheck()
  {
    System.out.println("AbortCheck");
    // Return true to abort, false to allow the method to continue.
    return false;
  }
  	
  // pctDone is a value from 0 to 100
  // (it is actually value from 0 to the PercentDoneScale property setting)
  public boolean PercentDone(int pctDone)
  {
    System.out.println(pctDone);
    // Return true to abort, false to allow the method to continue.
    // Note: A PercentDone event is the equivalent of an AbortCheck.  
    // When PercentDone events are frequently firing, AbortCheck events are suppressed.
    // AbortCheck events will fire when the time between PercentDone events is longer 
    // than the HeartbeatMs property setting.
    return false;
  }
  
  public void ProgressInfo(String name, String value)
  {
    System.out.println(name + ": " + value);
  }
  
  public void TaskCompleted(CkTask task)
  {
     System.out.println("task completed!");
  }
  
}
AbortCheck
public boolean AbortCheck();

Enables a method call to be aborted by triggering the AbortCheck event at intervals defined by the HeartbeatMs property. If HeartbeatMs is set to its default value of 0, no events will occur. For instance, set HeartbeatMs to 200 to trigger 5 AbortCheck events per second. Return true to abort; return false to continue (not abort)

More Information and Examples
top
PercentDone
public boolean PercentDone(int pctDone);

This provides the percentage completion for any method involving network communications or time-consuming processing, assuming the progress can be measured as a percentage. This event is triggered only when it's possible and logical to express the operation's progress as a percentage. The pctDone argument will range from 1 to 100. For methods that finish quickly, the number of PercentDone callbacks may vary, but the final callback will have pctDone equal to 100. For longer operations, callbacks will not exceed one per percentage point (e.g., 1, 2, 3, ..., 98, 99, 100).

The PercentDone callback also acts as an AbortCheck event. For fast methods where PercentDone fires, an AbortCheck event may not trigger since the PercentDone callback already provides an opportunity to abort. For longer operations, where time between PercentDone callbacks is extended, AbortCheck callbacks enable more responsive operation termination.

Return true to abort; return false to continue (not abort)

More Information and Examples
top
ProgressInfo
public void ProgressInfo(String name, String value);

This event callback provides tag name/value pairs that detail what occurs during a method call. To discover existing tag names, create code to handle the event, emit the pairs, and review them. Most tag names are self-explanatory.

More Information and Examples
top
TaskCompleted
public void TaskCompleted(CkTask task);

Called from the background thread when an asynchronous task completes.

top

Deprecated

BeginCompressBytes
boolean BeginCompressBytes(CkByteData data, CkByteData outData);
This method is deprecated and replaced by FirstChunk

The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2 .

Large amounts of binary byte data may be compressed in chunks by first calling BeginCompressBytes, followed by 0 or more calls to MoreCompressedBytes, and ending with a final call to EndCompressBytes. Each call returns 0 or more bytes of compressed data which may be output to a compressed data stream (such as a file, socket, etc.).

Returns true for success, false for failure.

top
BeginCompressBytesENC
boolean BeginCompressBytesENC(CkByteData data, CkString outStr);
String beginCompressBytesENC(CkByteData data);
This method is deprecated.

The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.

Large amounts of binary byte data may be compressed in chunks by first calling BeginCompressBytesENC, followed by 0 or more calls to MoreCompressedBytesENC, and ending with a final call to EndCompressBytesENC. Each call returns 0 or more characters of compressed data (encoded as a string according to the EncodingMode property setting) which may be output to a compressed data stream (such as a file, socket, etc.).

Returns true for success, false for failure.

top
BeginCompressString
boolean BeginCompressString(String str, CkByteData outData);
This method is deprecated and replaced by FirstChunk

The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.

Large amounts of string data may be compressed in chunks by first calling BeginCompressString, followed by 0 or more calls to MoreCompressedString, and ending with a final call to EndCompressString. Each call returns 0 or more bytes of compressed data which may be output to a compressed data stream (such as a file, socket, etc.).

Returns true for success, false for failure.

top
BeginCompressStringENC
boolean BeginCompressStringENC(String str, CkString outStr);
String beginCompressStringENC(String str);
This method is deprecated and replaced by FirstChunk

The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.

Large amounts of string data may be compressed in chunks by first calling BeginCompressStringENC, followed by 0 or more calls to MoreCompressedStringENC, and ending with a final call to EndCompressStringENC. Each call returns 0 or more characters of compressed data (encoded as a string according to the EncodingMode property setting) which may be output to a compressed data stream (such as a file, socket, etc.).

Returns true for success, false for failure.

top
BeginDecompressBytes
boolean BeginDecompressBytes(CkByteData data, CkByteData outData);
This method is deprecated and replaced by FirstChunk

The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.

A compressed data stream may be decompressed in chunks by first calling BeginDecompressBytes, followed by 0 or more calls to MoreDecompressedBytes, and ending with a final call to EndDecompressBytes. Each call returns 0 or more bytes of decompressed data.

Returns true for success, false for failure.

top
BeginDecompressBytesENC
boolean BeginDecompressBytesENC(String str, CkByteData outData);
This method is deprecated and replaced by FirstChunk

The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.

The input to this method is an encoded string containing compressed data. The EncodingMode property should be set prior to calling this method. The input string is decoded according to the EncodingMode (hex, base64, etc.) and then decompressed.

A compressed data stream may be decompressed in chunks by first calling BeginDecompressBytesENC, followed by 0 or more calls to MoreDecompressedBytesENC, and ending with a final call to EndDecompressBytesENC. Each call returns 0 or more bytes of decompressed data.

Returns true for success, false for failure.

top
BeginDecompressString
boolean BeginDecompressString(CkByteData data, CkString outStr);
String beginDecompressString(CkByteData data);
This method is deprecated and replaced by FirstChunk

The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.

A compressed data stream may be decompressed in chunks by first calling BeginDecompressString, followed by 0 or more calls to MoreDecompressedString, and ending with a final call to EndDecompressString. Each call returns 0 or more characters of decompressed text.

Returns true for success, false for failure.

top
BeginDecompressStringENC
boolean BeginDecompressStringENC(String str, CkString outStr);
String beginDecompressStringENC(String str);
This method is deprecated and replaced by FirstChunk

The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.

The input to this method is an encoded string containing compressed data. The EncodingMode property should be set prior to calling this method. The input string is decoded according to the EncodingMode (hex, base64, etc.) and then decompressed.

A compressed data stream may be decompressed in chunks by first calling BeginDecompressStringENC, followed by 0 or more calls to MoreDecompressedStringENC, and ending with a final call to EndDecompressStringENC. Each call returns 0 or more characters of decompressed text.

Returns true for success, false for failure.

top
CompressBytes Deprecated
boolean CompressBytes(CkByteData data, CkByteData outData);

Compresses a byte array and returns the compressed bytes.

This method is FirstChunk / LastChunk aware.

Returns true for success, false for failure.

top
CompressBytesAsync Deprecated (Android™) (Java)
CkTask CompressBytesAsync(CkByteData data);

Creates an asynchronous task to call the CompressBytes method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
CompressBytesENC Deprecated
boolean CompressBytesENC(CkByteData data, CkString outStr);
String compressBytesENC(CkByteData data);

Compresses a byte array and returns the compressed result as an encoded string.

The output encoding is controlled by EncodingMode.

This method is not FirstChunk / LastChunk aware.

Returns true for success, false for failure.

top
CompressBytesENCAsync Deprecated (Android™) (Java)
CkTask CompressBytesENCAsync(CkByteData data);

Creates an asynchronous task to call the CompressBytesENC method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
CompressStr Deprecated
boolean CompressStr(String str, CkBinData bd);
Introduced in version 11.0.0

Compresses a string and appends the compressed bytes to a BinData object.

The string is converted to bytes using the charset specified by the Charset property.

This method is FirstChunk / LastChunk aware.

Returns true for success, false for failure.

top
CompressStrAsync Deprecated (Android™) (Java)
CkTask CompressStrAsync(String str, CkBinData bd);
Introduced in version 11.0.0

Creates an asynchronous task to call the CompressStr method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
CompressString Deprecated
boolean CompressString(String str, CkByteData outData);

Compresses a string and returns the compressed bytes.

The string is converted to bytes using the Charset property.

This method is FirstChunk / LastChunk aware.

Returns true for success, false for failure.

top
CompressStringAsync Deprecated (Android™) (Java)
CkTask CompressStringAsync(String str);

Creates an asynchronous task to call the CompressString method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
DecompressBytes Deprecated
boolean DecompressBytes(CkByteData data, CkByteData outData);

Decompresses compressed byte data and returns the decompressed bytes.

This method is FirstChunk / LastChunk aware.

Returns true for success, false for failure.

top
DecompressBytesAsync Deprecated (Android™) (Java)
CkTask DecompressBytesAsync(CkByteData data);

Creates an asynchronous task to call the DecompressBytes method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
DecompressBytesENC Deprecated
boolean DecompressBytesENC(String encodedCompressedData, CkByteData outData);

Decompresses compressed data supplied as an encoded string and returns the decompressed bytes.

The input string is decoded according to EncodingMode before being decompressed.

Returns true for success, false for failure.

top
DecompressBytesENCAsync Deprecated (Android™) (Java)
CkTask DecompressBytesENCAsync(String encodedCompressedData);

Creates an asynchronous task to call the DecompressBytesENC method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
DecompressString Deprecated
boolean DecompressString(CkByteData data, CkString outStr);
String decompressString(CkByteData data);

Decompresses compressed byte data and returns the resulting string.

The decompressed bytes are converted to text using the Charset property.

This method is FirstChunk / LastChunk aware.

Returns true for success, false for failure.

top
EndCompressBytes
boolean EndCompressBytes(CkByteData outData);
This method is deprecated.

The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.

Must be callled to finalize a compression stream. Returns any remaining (buffered) compressed data.

(See BeginCompressBytes)

Returns true for success, false for failure.

top
EndCompressBytesENC
boolean EndCompressBytesENC(CkString outStr);
String endCompressBytesENC();
This method is deprecated.

The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.

Must be callled to finalize a compression stream. Returns any remaining (buffered) compressed data.

(See BeginCompressBytesENC)

Returns true for success, false for failure.

top
EndCompressString
boolean EndCompressString(CkByteData outData);
This method is deprecated.

The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.

Must be callled to finalize a compression stream. Returns any remaining (buffered) compressed data.

(See BeginCompressString)

Returns true for success, false for failure.

top
EndCompressStringENC
boolean EndCompressStringENC(CkString outStr);
String endCompressStringENC();
This method is deprecated.

The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.

Must be callled to finalize a compression stream. Returns any remaining (buffered) compressed data.

(See BeginCompressStringENC)

Returns true for success, false for failure.

top
EndDecompressBytes
boolean EndDecompressBytes(CkByteData outData);
This method is deprecated.

The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.

Called to finalize the decompression stream and return any remaining (buffered) decompressed data.

(See BeginDecompressBytes)

Returns true for success, false for failure.

top
EndDecompressBytesENC
boolean EndDecompressBytesENC(CkByteData outData);
This method is deprecated.

The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.

Called to finalize the decompression stream and return any remaining (buffered) decompressed data.

The input to this method is an encoded string containing compressed data. The EncodingMode property should be set prior to calling this method. The input string is decoded according to the EncodingMode (hex, base64, etc.) and then decompressed.

(See BeginDecompressBytesENC)

Returns true for success, false for failure.

top
EndDecompressString
boolean EndDecompressString(CkString outStr);
String endDecompressString();
This method is deprecated.

The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.

Called to finalize the decompression stream and return any remaining (buffered) decompressed data.

(See BeginDecompressString)

Returns true for success, false for failure.

top
EndDecompressStringENC
boolean EndDecompressStringENC(CkString outStr);
String endDecompressStringENC();
This method is deprecated.

The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.

Called to finalize the decompression stream and return any remaining (buffered) decompressed data.

The input to this method is an encoded string containing compressed data. The EncodingMode property should be set prior to calling this method. The input string is decoded according to the EncodingMode (hex, base64, etc.) and then decompressed.

(See BeginDecompressStringENC)

Returns true for success, false for failure.

top
MoreCompressBytes
boolean MoreCompressBytes(CkByteData data, CkByteData outData);
This method is deprecated.

(See BeginCompressBytes)

Returns true for success, false for failure.

top
MoreCompressBytesENC
boolean MoreCompressBytesENC(CkByteData data, CkString outStr);
String moreCompressBytesENC(CkByteData data);
This method is deprecated.

(See BeginCompressBytesENC)

Returns true for success, false for failure.

top
MoreCompressString
boolean MoreCompressString(String str, CkByteData outData);
This method is deprecated.

(See BeginCompressString)

Returns true for success, false for failure.

top
MoreCompressStringENC
boolean MoreCompressStringENC(String str, CkString outStr);
String moreCompressStringENC(String str);
This method is deprecated.

(See BeginCompressStringENC)

Returns true for success, false for failure.

top
MoreDecompressBytes
boolean MoreDecompressBytes(CkByteData data, CkByteData outData);
This method is deprecated.

(See BeginDecompressBytes)

Returns true for success, false for failure.

top
MoreDecompressBytesENC
boolean MoreDecompressBytesENC(String str, CkByteData outData);
This method is deprecated.

The input to this method is an encoded string containing compressed data. The EncodingMode property should be set prior to calling this method. The input string is decoded according to the EncodingMode (hex, base64, etc.) and then decompressed.

(See BeginDecompressBytesENC)

Returns true for success, false for failure.

top
MoreDecompressString
boolean MoreDecompressString(CkByteData data, CkString outStr);
String moreDecompressString(CkByteData data);
This method is deprecated.

(See BeginDecompressString)

Returns true for success, false for failure.

top
MoreDecompressStringENC
boolean MoreDecompressStringENC(String str, CkString outStr);
String moreDecompressStringENC(String str);
This method is deprecated.

The input to this method is an encoded string containing compressed data. The EncodingMode property should be set prior to calling this method. The input string is decoded according to the EncodingMode (hex, base64, etc.) and then decompressed.

(See BeginDecompressStringENC)

Returns true for success, false for failure.

top