CkBinData Java Reference Documentation

CkBinData

Current Version: 9.5.0.80

Container for binary data. Provides methods for getting, setting, appending, etc. in binary and string encoded formats.

Object Creation

CkBinData obj = new CkBinData();

Properties

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

Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = true and failure = false.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
NumBytes
int get_NumBytes();
Introduced in version 9.5.0.51

The number of bytes contained within the object.

top

Methods

AppendBd
boolean AppendBd(CkBinData binData);
Introduced in version 9.5.0.62

Appends the contents of another BinData to this object.

Returns true for success, false for failure.

top
AppendBinary
boolean AppendBinary(CkByteData data);
Introduced in version 9.5.0.51

Appends binary data to the current contents, if any.

Returns true for success, false for failure.

top
AppendBom
boolean AppendBom(String charset);
Introduced in version 9.5.0.62

Appends the appropriate BOM (byte order mark), also known as a "preamble", for the given charset. If the charset has no defined BOM, then nothing is appended. An application would typically call this to append the utf-8, utf-16, or utf-32 BOM.

Returns true for success, false for failure.

top
AppendByte
boolean AppendByte(int byteValue);
Introduced in version 9.5.0.77

Appends a single byte. The byteValue should be a value from 0 to 255.

Returns true for success, false for failure.

top
AppendEncoded
boolean AppendEncoded(String encData, String encoding);
Introduced in version 9.5.0.51

Appends encoded binary data to the current data. The encoding may be "Base64", "modBase64", "base64Url", "Base32", "Base58", "QP" (for quoted-printable), "URL" (for url-encoding), "Hex", or any of the encodings found at Chilkat Binary Encodings List.

Returns true for success, false for failure.

top
AppendEncodedSb
boolean AppendEncodedSb(CkStringBuilder sb, String encoding);
Introduced in version 9.5.0.62

Decodes the contents of sb and appends the decoded bytes to this object. The encoding may be "Base64", "modBase64", "base64Url", "Base32", "Base58", "QP" (for quoted-printable), "URL" (for url-encoding), "Hex", or any of the encodings found at Chilkat Binary Encodings List.

Returns true for success, false for failure.

top
AppendInt2
boolean AppendInt2(int value, boolean littleEndian);
Introduced in version 9.5.0.77

Appends a 16-bit integer (2 bytes). If littleEndian is true, then the integer bytes are appended in little-endian byte order, otherwise big-endian byte order is used.

Returns true for success, false for failure.

top
AppendInt4
boolean AppendInt4(int value, boolean littleEndian);
Introduced in version 9.5.0.77

Appends a 32-bit integer (4 bytes). If littleEndian is true, then the integer bytes are appended in little-endian byte order, otherwise big-endian byte order is used.

Returns true for success, false for failure.

top
AppendPadded
boolean AppendPadded(String str, String charset, boolean padWithSpace, int fieldLen);
Introduced in version 9.5.0.80

Appends a string to this object, padded to the fieldLen with NULL or SPACE chars. If padWithSpace is true, then SPACE chars are used and the string is not null-terminated. If fieldLen is false, then null bytes are used. The charset controls the byte representation to use, such as "utf-8".

Note: This call will always append a total number of bytes equal to fieldLen. If the str is longer than fieldLen, the method returns false to indicate failure and nothing is appended.

Returns true for success, false for failure.

top
AppendSb
boolean AppendSb(CkStringBuilder sb, String charset);
Introduced in version 9.5.0.62

Appends the contents of a StringBuilder to this object.

Returns true for success, false for failure.

top
AppendString
boolean AppendString(String str, String charset);
Introduced in version 9.5.0.62

Appends a string to this object. (This does not append the BOM. If a BOM is required, the AppendBom method can be called to append the appropriate BOM.)

Returns true for success, false for failure.

top
Clear
boolean Clear();
Introduced in version 9.5.0.51

Clears the contents.

Returns true for success, false for failure.

top
ContentsEqual
boolean ContentsEqual(CkBinData binData);
Introduced in version 9.5.0.62

Return true if the contents of this object equals the contents of binData.

top
GetBinary
boolean GetBinary(CkByteData outData);
Introduced in version 9.5.0.51

Retrieves the binary data contained within the object.

Returns true for success, false for failure.

top
GetBinaryChunk
boolean GetBinaryChunk(int offset, int numBytes, CkByteData outData);
Introduced in version 9.5.0.51

Retrieves a chunk of the binary data contained within the object.

Returns true for success, false for failure.

top
GetBytesPtr
byte[] GetBytesPtr();
Introduced in version 9.5.0.80

Returns a pointer to the internal buffer. Be careful with this method because if additional data is appended, the data within the object may be relocated and the pointer may cease to be valid.

top
GetEncoded
boolean GetEncoded(String encoding, CkString outStr);
String getEncoded(String encoding);
Introduced in version 9.5.0.51

Retrieves the binary data as an encoded string. The encoding may be "Base64", "modBase64", "base64Url", "Base32", "Base58", "QP" (for quoted-printable), "URL" (for url-encoding), "Hex", or any of the encodings found at Chilkat Binary Encodings List.

Returns true for success, false for failure.

top
GetEncodedChunk
boolean GetEncodedChunk(int offset, int numBytes, String encoding, CkString outStr);
String getEncodedChunk(int offset, int numBytes, String encoding);
Introduced in version 9.5.0.51

Retrieves a chunk of the binary data and returns it in encoded form. The encoding may be "Base64", "modBase64", "base64Url", "Base32", "Base58", "QP" (for quoted-printable), "URL" (for url-encoding), "Hex", or any of the encodings found at Chilkat Binary Encodings List.

Returns true for success, false for failure.

top
GetEncodedSb
boolean GetEncodedSb(String encoding, CkStringBuilder sb);
Introduced in version 9.5.0.64

Writes the encoded data to a StringBuilder. The encoding may be "Base64", "modBase64", "base64Url", "Base32", "Base58", "QP" (for quoted-printable), "URL" (for url-encoding), "Hex", or any of the encodings found at Chilkat Binary Encodings List.

Returns true for success, false for failure.

top
GetString
boolean GetString(String charset, CkString outStr);
String getString(String charset);
Introduced in version 9.5.0.67

Interprets the bytes according to charset and returns the string. The charset can be "utf-8", "utf-16", "ansi", "iso-8859-*", "windows-125*", or any of the supported character encodings listed in the link below.

Returns true for success, false for failure.

More Information and Examples
top
LoadBinary
boolean LoadBinary(CkByteData data);
Introduced in version 9.5.0.51

Loads binary data and replaces the current contents, if any.

Returns true for success, false for failure.

top
LoadEncoded
boolean LoadEncoded(String encData, String encoding);
Introduced in version 9.5.0.51

Loads binary data from an encoded string, replacing the current contents, if any. The encoding may be "Base64", "modBase64", "base64Url", "Base32", "Base58", "QP" (for quoted-printable), "URL" (for url-encoding), "Hex", or any of the encodings found at Chilkat Binary Encodings List.

Returns true for success, false for failure.

top
LoadFile
boolean LoadFile(String path);
Introduced in version 9.5.0.51

Loads data from a file.

Returns true for success, false for failure.

top
RemoveChunk
boolean RemoveChunk(int offset, int numBytes);
Introduced in version 9.5.0.51

Removes a chunk of bytes from the binary data.

top
SecureClear
boolean SecureClear();
Introduced in version 9.5.0.67

Securely clears the contents by writing 0 bytes to the memory prior to deallocating the internal memory.

Returns true for success, false for failure.

top
WriteFile
boolean WriteFile(String path);
Introduced in version 9.5.0.62

Writes the contents to a file.

Returns true for success, false for failure.

top